Skip to content

feat: consolidate markdown documentation into docs structure #484

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 12, 2025
Merged

feat: consolidate markdown documentation into docs structure #484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8fedfeb
feat: consolidate markdown documentation into docs structure
JnyJny Aug 12, 2025
51ef57e
resolve: merge conflict in mkdocs.yml navigation
JnyJny Aug 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/cli/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,4 +175,10 @@ The CLI provides clear error messages:
privileges

For detailed troubleshooting, use the `--debug` flag to see diagnostic
information.
information.

## Advanced Topics

- **[Light Selection Guide](selection-guide.md)** - Comprehensive guide to targeting specific lights in multi-device setups
- **[Command Reference](commands.md)** - Complete list of available commands and options
- **[Usage Examples](examples.md)** - Real-world integration scenarios and automation patterns
0 LIGHT_SELECTION_GUIDE.md → docs/cli/selection-guide.md
View file
Open in desktop
File renamed without changes.
0 MANAGER_IMPROVEMENTS.md → docs/contributing/architecture-decisions.md
View file
Open in desktop
File renamed without changes.
0 CLI_MIGRATION_EXAMPLE.md → docs/contributing/migration-guide.md
View file
Open in desktop
File renamed without changes.
6 changes: 5 additions & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ nav:
- Overview: cli/index.md
- Commands: cli/commands.md
- Examples: cli/examples.md
- Selection Guide: cli/selection-guide.md
- Web API:
- Overview: api/index.md
- Endpoints: api/endpoints.md
Expand All @@ -64,7 +65,10 @@ nav:
- Overview: devices/index.md
- LED Support: devices/led-support.md
- Effects: effects.md
- Contributing: contributing.md
- Contributing:
- Overview: contributing.md
- Migration Guide: contributing/migration-guide.md
- Architecture Decisions: contributing/architecture-decisions.md

extra:
version:
Expand Down
Loading