Skip to content

Restore docs folder for critical implementation guides #4129

@KJ7LNW

Description

@KJ7LNW

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

  1. Restore the docs folder to the project structure
  2. Migrate the documentation from PR docs: add enum settings implementation guide #2671 into this folder
  3. Establish clear guidelines for what documentation should be included in this folder
  4. 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

No one assigned

    Labels

    Issue - In ProgressSomeone is actively working on this. Should link to a PR soon.documentationImprovements or additions to documentation

    Type

    No type

    Projects

    Status

    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions