-
Notifications
You must be signed in to change notification settings - Fork 2.6k
docs: Add comprehensive repository analysis document #7340
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
Conversation
- Added detailed analysis of all three git repositories in the workspace - Covers Roo-Code (VS Code extension), Roo-Code-Cloud (infrastructure), and Roo-Code-Docs (documentation) - Includes purpose, technology stack, key features, and repository relationships - Provides comprehensive overview for developers and stakeholders
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 reviewed my own code and found it wanting—turns out I can't even get the directory structure right.
|
|
||
| There are **3 main git repositories** in the current directory: | ||
|
|
||
| 1. [`Roo-Code/`](Roo-Code/) - The main VS Code extension |
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.
The relative links here won't work correctly. Since this document is in the Roo-Code repository but references sibling repositories at the parent level, these links will be broken. Should we either:
- Move this document to the parent directory (/data/repos/), or
- Update all links to use correct relative paths like
../Roo-Code-Cloud/?
The same issue applies to all repository links throughout the document (lines 9-11, 17, 50, 96).
| @@ -0,0 +1,167 @@ | |||
| # Git Repository Analysis | |||
|
|
|||
| This document provides a comprehensive overview of the git repositories found in the current working directory, explaining the purpose and contents of each repository. | |||
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.
This statement is misleading - the repositories are actually in the parent directory, not the current working directory where this document resides. Could we clarify this to avoid confusion? Perhaps: "git repositories found in the parent directory" or specify the actual location?
| - **`scripts/`**: Build and development scripts | ||
|
|
||
| ### Development | ||
| - **Node.js Version**: 20.19.2 |
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.
Could we verify these Node.js versions are accurate? The document mentions 20.19.2 here and 22.x for Roo-Code-Cloud (line 80). It might be helpful to add a note about version compatibility requirements between the repositories.
| - **Customization**: Custom instructions, modes, local models, and auto-approval settings | ||
|
|
||
| ### Repository Structure | ||
| - **`src/`**: Main extension source code including [`extension.ts`](Roo-Code/src/extension.ts) (entry point) |
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.
Consider adding links to other important configuration files for better navigation, such as:
- package.json
- tsconfig.json
- .github/workflows/ (CI/CD configs)
- turbo.json
This would make the document more useful as a navigation reference.
|
|
||
| ## Repository Relationships | ||
|
|
||
| ```mermaid |
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.
Nice diagram! Have we verified this Mermaid syntax renders correctly in the target viewing environments (GitHub, VS Code preview, documentation site)? Some platforms have specific requirements for Mermaid blocks.
This PR adds a comprehensive analysis document that lists and explains each of the git repositories in the workspace.
Summary
Added
repository-analysis.mdwhich provides detailed information about all three repositories:Key Features
Benefits
This documentation will be valuable for onboarding new team members and providing clarity on the overall project structure.
Important
Adds
repository-analysis.mdwith detailed analysis ofRoo-Code,Roo-Code-Cloud, andRoo-Code-Docsrepositories, including purpose, features, and relationships.repository-analysis.mdwith detailed analysis ofRoo-Code,Roo-Code-Cloud, andRoo-Code-Docsrepositories.This description was created by
for b3793e5. You can customize this summary. It will automatically update as commits are pushed.