- 
          
- 
                Notifications
    You must be signed in to change notification settings 
- Fork 33.6k
doc: reorganize README.md #60490
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Open
      
      
            joyeecheung
  wants to merge
  1
  commit into
  nodejs:main
  
    
      
        
          
  
    
      Choose a base branch
      
     
    
      
        
      
      
        
          
          
        
        
          
            
              
              
              
  
           
        
        
          
            
              
              
           
        
       
     
  
        
          
            
          
            
          
        
       
    
      
from
joyeecheung:reorg-readme
  
      
      
   
  
    
  
  
  
 
  
      
    base: main
Could not load branches
            
              
  
    Branch not found: {{ refName }}
  
            
                
      Loading
              
            Could not load tags
            
            
              Nothing to show
            
              
  
            
                
      Loading
              
            Are you sure you want to change the base?
            Some commits from the old base branch may be removed from the timeline,
            and old review comments may become outdated.
          
          
                
     Open
            
            doc: reorganize README.md #60490
      
        
          +191
        
        
          −171
        
        
          
        
      
    
  
Conversation
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
    The README previously mixes information of different levels of details e.g. some are just links, some include detailed instructions and commands. This reorganizes README.md to make it more like a map of links. The release information are moved into a dedicated document. Only the releaser list remains in the README.
e3266ab    to
    a4719b6      
    Compare
  
    
              
                    aduh95
  
              
              reviewed
              
                  
                    Oct 29, 2025 
                  
              
              
            
            
      Comment on lines
    
      -780
     to 
      -816
    
  
  | ### Release keys | ||
|  | ||
| Primary GPG keys for Node.js Releasers (some Releasers sign with subkeys): | ||
|  | ||
| * **Antoine du Hamel** <<duhamelantoine1995@gmail.com>> | ||
| `5BE8A3F6C8A5C01D106C0AD820B1A390B168D356` | ||
| * **Juan José Arboleda** <<soyjuanarbol@gmail.com>> | ||
| `DD792F5973C6DE52C432CBDAC77ABFA00DDBF2B7` | ||
| * **Marco Ippolito** <<marcoippolito54@gmail.com>> | ||
| `CC68F5A3106FF448322E48ED27F5E38D5B0A215F` | ||
| * **Michaël Zasso** <<targos@protonmail.com>> | ||
| `8FCCA13FEF1D0C2E91008E09770F7A9A5AE15600` | ||
| * **Rafael Gonzaga** <<rafael.nunu@hotmail.com>> | ||
| `890C08DB8579162FEE0DF9DB8BEAB4DFCF555EF4` | ||
| * **Richard Lau** <<richard.lau@ibm.com>> | ||
| `C82FA3AE1CBEDC6BE46B9360C43CEC45C17AB93C` | ||
| * **Ruy Adorno** <<ruyadorno@hotmail.com>> | ||
| `108F52B48DB57BB0CC439B2997B01419BD92F80A` | ||
| * **Ulises Gascón** <<ulisesgascongonzalez@gmail.com>> | ||
| `A363A499291CBBC940DD62E41F10027AF002F8B0` | ||
|  | ||
| You can use the keyring the project maintains at | ||
| <https://github.com/nodejs/release-keys/raw/refs/heads/main/gpg-only-active-keys/pubring.kbx>. | ||
| Alternatively, you can import them from a public key server. Have in mind that | ||
| the project cannot guarantee the availability of the server nor the keys on | ||
| that server. | ||
|  | ||
| ```bash | ||
| gpg --keyserver hkps://keys.openpgp.org --recv-keys 5BE8A3F6C8A5C01D106C0AD820B1A390B168D356 # Antoine du Hamel | ||
| gpg --keyserver hkps://keys.openpgp.org --recv-keys DD792F5973C6DE52C432CBDAC77ABFA00DDBF2B7 # Juan José Arboleda | ||
| gpg --keyserver hkps://keys.openpgp.org --recv-keys CC68F5A3106FF448322E48ED27F5E38D5B0A215F # Marco Ippolito | ||
| gpg --keyserver hkps://keys.openpgp.org --recv-keys 8FCCA13FEF1D0C2E91008E09770F7A9A5AE15600 # Michaël Zasso | ||
| gpg --keyserver hkps://keys.openpgp.org --recv-keys 890C08DB8579162FEE0DF9DB8BEAB4DFCF555EF4 # Rafael Gonzaga | ||
| gpg --keyserver hkps://keys.openpgp.org --recv-keys C82FA3AE1CBEDC6BE46B9360C43CEC45C17AB93C # Richard Lau | ||
| gpg --keyserver hkps://keys.openpgp.org --recv-keys 108F52B48DB57BB0CC439B2997B01419BD92F80A # Ruy Adorno | ||
| gpg --keyserver hkps://keys.openpgp.org --recv-keys A363A499291CBBC940DD62E41F10027AF002F8B0 # Ulises Gascón | ||
| ``` | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we can safely move this, there are many scripts out there that expect to find this in the README (including our own workflow in nodejs/release-keys)
  
    Sign up for free
    to join this conversation on GitHub.
    Already have an account?
    Sign in to comment
  
      
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
The README previously mixes information of different levels of details e.g. some are just links, some include detailed instructions and commands.
This reorganizes README.md to make it more like a map of links. The release information are moved into a dedicated document. Only the releaser list remains in the README.