Skip to content

Comments

fix(readme): ordering#1327

Merged
spomichter merged 1 commit intodevfrom
paul/fix/readme-order
Feb 21, 2026
Merged

fix(readme): ordering#1327
spomichter merged 1 commit intodevfrom
paul/fix/readme-order

Conversation

@paul-nechifor
Copy link
Contributor

Previous:

  # Intro                                                                                                                                                                             
  # Hardware                                                                                                                                                                          
  # Installation                                                                                                                                                                      
    ## System Install                                                                                                                                                                 
    ## Python Installs                                                                                                                                                                
      ### Quickstart                                                                                                                                                                  
      ### Use DimOS as a Library                                                                                                                                                      
      ### Blueprints                                                                                                                                                                  
    ## Library API                                                                                                                                                                    
      ### Develop on DimOS                                                                                                                                                            
      ### Demos                                                                                                                                                                       
  # Development                                                                                                                                                                       
    ## Multi Language Support                                                                                                                                                         
    ## ROS interop   

New:

  # Intro                                                                                                                                                                             
  # Hardware                                                                                                                                                                          
  # Installation                                                                                                                                                                      
    ## System Install                                                                                                                                                                 
    ## Python Install                                                                                                                                                                 
      ### Quickstart                                                                                                                                                                  
  # Usage                                                                                                                                                                             
    ## Use DimOS as a Library                                                                                                                                                         
    ## Blueprints                                                                                                                                                                     
    ## Library API                                                                                                                                                                    
    ## Demos                                                                                                                                                                          
  # Development                                                                                                                                                                       
    ## Develop on DimOS
    ## Multi Language Support
    ## ROS Interop

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 20, 2026

Greptile Summary

This PR reorganizes the README structure for better logical flow. Key improvements:

  • Fixed "Python Installs" → "Python Install" (singular)
  • Created new top-level "Usage" section grouping library usage, blueprints, API docs, and demos
  • Moved "Develop on DimOS" under "Development" section where it belongs
  • Fixed "ROS interop" capitalization to "ROS Interop"

The new structure improves navigation by clearly separating Installation (setup), Usage (how to use), and Development (contributing/developing).

Confidence Score: 5/5

  • This PR is completely safe to merge with zero risk
  • This is a documentation-only change that improves README organization with no code changes, no functional impact, and clear improvements to document structure
  • No files require special attention

Important Files Changed

Filename Overview
README.md Improved README structure by reorganizing sections into logical groups (Installation, Usage, Development)

Last reviewed commit: d576354

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, no comments

Edit Code Review Agent Settings | Greptile

spomichter
spomichter previously approved these changes Feb 21, 2026
@spomichter spomichter merged commit db6ec64 into dev Feb 21, 2026
42 of 46 checks passed
@spomichter spomichter deleted the paul/fix/readme-order branch February 21, 2026 10:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants