Plan: Reorganize documentation structure and consolidate agent configs - #51
Merged
Conversation
Move reference content out of CLAUDE.md into DEVELOPMENT.md and docs/. Make AGENTS.md use the include directive to keep agent configs in sync automatically. https://claude.ai/code/session_018ggZVMKDKMB3tvmVbYLCLn
Add include directives so agents and contributors still see development info inline. Add README.md update task (step 17). https://claude.ai/code/session_018ggZVMKDKMB3tvmVbYLCLn
Update task 17 so README.md includes DEVELOPMENT.md and links to docs/design/, docs/guides/, docs/background/, and plan/. https://claude.ai/code/session_018ggZVMKDKMB3tvmVbYLCLn
Replace invalid `<?include ?>` shorthand with correct multi-line processing instruction syntax (`<?include` / `<?/include?>`) per Copilot review comments on PR #50. https://claude.ai/code/session_01UYSXHUyo9LLpoZjADkcaj9
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new planning document (plan/68_reorganize-docs.md) that outlines a reorganization of the project's documentation structure. The plan proposes moving reference content from CLAUDE.md into dedicated files (DEVELOPMENT.md, docs/design/, docs/guides/, docs/background/) and using mdsmith's <?include / <?/include?> processing-instruction directives to keep agent configuration files (AGENTS.md, .github/copilot-instructions.md) automatically in sync with the primary source in CLAUDE.md.
Changes:
- New planning document with 21 implementation tasks covering file creation, content migration, include directive implementation, and validation
- Acceptance criteria (16 items) defining observable completion checkpoints for the reorganization
Address Copilot review: moving directories also breaks links *to* those directories from files that are not being moved. https://claude.ai/code/session_01UYSXHUyo9LLpoZjADkcaj9
3 tasks
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
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.
Summary
This PR adds a planning document for reorganizing the project's documentation structure. The plan outlines moving reference content out of CLAUDE.md into dedicated files and establishing a single source of truth using mdsmith's include directives to keep agent configurations in sync across multiple files.
Key Changes
New planning document (
plan/68_reorganize-docs.md) that details:DEVELOPMENT.mdfile to consolidate development-related sectionsdocs/design/,docs/guides/,docs/background/Structured approach with 21 implementation tasks covering:
Clear acceptance criteria (16 checkpoints) ensuring:
Implementation Details
The plan uses mdsmith's processing-instruction syntax (
<?include/<?/include?>) to maintain a single source of truth while keeping multiple documentation files in sync. This approach eliminates manual duplication and ensures consistency across CLAUDE.md, AGENTS.md, and .github/copilot-instructions.md.https://claude.ai/code/session_01UYSXHUyo9LLpoZjADkcaj9