docs: comprehensive documentation audit and reorganization #92
Conversation
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
- Create new documentation structure with clear organization - Move internal/process docs to docs-archive/ (gitignored) - Reorganize component docs into docs/components/ - Add comprehensive development guides in docs/development/ - Create API reference structure in docs/api/ - Add examples documentation in docs/examples/ - Update .gitignore to exclude archived documentation - Update main README with links to new documentation structure - Create navigation README in docs/ directory - Preserve CLAUDE.md as it contains AI agent instructions
github-actions
bot
added
status: in-code-review
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
Comprehensive documentation audit and reorganization as requested in issue #84.
Changes
New Documentation Structure
docs/directory:components/- Component-specific documentationdevelopment/- Developer guides (setup, workflow, testing, contributing, architecture)deployment/- Deployment documentationapi/- API referenceexamples/- Code examples and patternsFiles Archived
docs-archive/(gitignored)Files Preserved
CLAUDE.mdin root as it contains AI agent instructionsDocumentation Created
docs/README.md- Navigation index for all documentationdocs/development/setup.md- Getting started guidedocs/development/testing.md- Testing guidedocs/development/contributing.md- Contribution guidelinesdocs/development/architecture.md- Architecture overviewdocs/api/README.md- API reference indexdocs/examples/README.md- Code examplesdocs/components/filter-presets.md- Filter presets overviewdocs/components/category-selector.md- Placeholder for upcoming feature (Feature: Add category management and export functionality to filter presets #77)Updates
README.mdwith links to new documentation structure.gitignoreto exclude archived documentationdocs/components/Notes
Fixes #84
Test Plan