feat: consolidate markdown documentation into docs structure #484
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
• Consolidate all project markdown documentation under the
docs/
directory• Organize developer-focused documents in appropriate subsections
• Improve documentation discoverability through structured navigation
• Exclude hardware device docs which are migrating to busylight-core repo
Files Moved
CLI Documentation:
LIGHT_SELECTION_GUIDE.md
→docs/cli/selection-guide.md
Contributing Documentation:
CLI_MIGRATION_EXAMPLE.md
→docs/contributing/migration-guide.md
MANAGER_IMPROVEMENTS.md
→docs/contributing/architecture-decisions.md
Navigation Updates
Updated
mkdocs.yml
:Enhanced CLI Overview:
Benefits
For Users:
For Contributors:
For Maintainers:
Files Excluded
docs/hardware/
) - Will be migrated to busylight-core repoTest Results
mkdocs build --strict
)🤖 Generated with Claude Code