-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Description
This issue proposes restoring the docs folder to the project to house critical implementation guides, specifically for settings implementation.
Background
In PR #2671 (#2671), @KJ7LNW created comprehensive documentation for implementing enum/compound settings in the application. However, as noted in the PR comments, the docs folder has been removed from the project, leaving no clear location for this valuable documentation.
Problem Statement
As stated by @KJ7LNW in the PR comments:
"Adding settings to roo code is extremely hard and requires ~12 changes for a single check box. That documentation was critical for AI success in creating new settings efficiently."
Without proper documentation on settings implementation, developers (including AI assistants) face significant challenges when adding new settings to the application.
Proposed Solution
- Restore the docs folder to the project structure
- Migrate the documentation from PR docs: add enum settings implementation guide #2671 into this folder
- Establish clear guidelines for what documentation should be included in this folder
- Ensure the documentation is accessible within the directory tree for AI use
This would provide a centralized location for critical implementation guides that help both human developers and AI assistants understand complex workflows in the codebase.
Related Links
Metadata
Metadata
Assignees
Labels
Type
Projects
Status