Reorganize documentation folder structure - #188
Merged
Conversation
Organize documentation into four clear categories to help developers quickly find current implementation docs vs. planning documents: **New Structure:** - docs/code/ - Current code implementation documentation - docs/processes/ - Development and operational processes - docs/tooling/ - Setup and configuration guides - docs/planning/ - Design docs, proposals, and reviews **Changes:** - Created docs/README.md with complete navigation guide - Moved 27 documentation files to appropriate categories - Grouped related planning docs into subfolders (deep-linking, patrol-firebase-testing) - Converted ALL_CAPS filenames to lowercase-kebab-case for consistency - Updated all references in CLAUDE.md, README.md, and test-e2e/README.md - Added implementation status indicators (✅ implemented, ❌ not implemented, ⏳ partial) - Documented alternative approaches and conflicting plans with clear decisions - Added "Quick Reference" section for common lookup scenarios **Benefits:** - New developers can quickly distinguish current vs. planned state - Clear separation of implementation docs from proposals - Better discoverability with categorical organization - Status indicators prevent confusion about what's implemented - Alternatives section documents decision rationale All file moves preserve git history via 'git mv'.
Update all references to moved documentation files: - CLAUDE.md: Update accessibility and API doc paths - README.md: Update all doc links to new categorized structure - test-e2e/README.md: Update Flutter web testing guide reference All links now point to reorganized docs/ structure (code/, processes/, tooling/, planning/).
richardthe3rd
marked this pull request as ready for review
December 23, 2025 21:35
Contributor
LCOV of commit
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
🚀 Cloudflare Pages PreviewYour preview deployment is ready! Preview URL: https://claude-reorganize-docs-folde.staging-cambeerfestival.pages.dev This preview will be automatically updated when you push new commits to this PR. |
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
2 participants
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.
This pull request reorganizes and updates documentation references throughout the project to reflect a new, more structured docs directory layout. It also introduces a comprehensive
docs/README.mdthat explains the new documentation structure, categories, and how to navigate or contribute to the docs. All links in the main guides and documentation now point to their new locations.The most important changes are:
Documentation Structure & Navigation:
docs/README.mdthat explains the new documentation organization, describes each category (code/,processes/,tooling/,planning/), and provides quick references and contribution guidelines.Reference Updates in Main Documentation:
README.mdto point to their new locations underdocs/code/,docs/tooling/,docs/processes/, anddocs/planning/as appropriate, ensuring consistency with the new structure. [1] [2] [3]README.mdandCLAUDE.mdto their new paths underdocs/code/. [1] [2]This reorganization makes it much easier to find, maintain, and contribute to documentation, and ensures that all references are accurate and up to date.