Skip to content

Conversation

JnyJny
Copy link
Owner

@JnyJny JnyJny commented Aug 12, 2025

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.mddocs/cli/selection-guide.md
    • Comprehensive guide to light targeting in multi-device setups
    • Covers selection by index, name, pattern, and programmatic methods
    • Added to CLI navigation and cross-referenced from overview

Contributing Documentation:

  • CLI_MIGRATION_EXAMPLE.mddocs/contributing/migration-guide.md

    • Developer guide for migrating from old LightManager to new LightController
    • Before/after code examples and migration benefits
  • MANAGER_IMPROVEMENTS.mddocs/contributing/architecture-decisions.md

    • Internal development notes on LightManager → LightController transition
    • Analysis of improvements and implementation details

Navigation Updates

Updated mkdocs.yml:

  • Added CLI subsection with Selection Guide
  • Added Contributing subsection with Migration Guide and Architecture Decisions
  • Maintains logical documentation flow and hierarchy

Enhanced CLI Overview:

  • Added "Advanced Topics" section with cross-references
  • Links to Selection Guide, Commands, and Examples
  • Improves documentation discoverability

Benefits

For Users:

  • All documentation properly organized in one location
  • Better navigation and discoverability through MkDocs
  • Clear separation between user guides and developer documentation

For Contributors:

  • Developer-focused documentation easily accessible
  • Migration guides available for internal development
  • Architecture decisions documented for future reference

For Maintainers:

  • Cleaner repository structure with consolidated documentation
  • Easier to maintain and update documentation
  • Consistent organization patterns

Files Excluded

  • Hardware device docs (docs/hardware/) - Will be migrated to busylight-core repo
  • Root-level essential files - README.md, CONTRIBUTING.md, CLAUDE.md, CHANGELOG.md remain in root

Test Results

  • MkDocs build succeeds without errors (mkdocs build --strict)
  • All navigation links work correctly
  • Cross-references between documents function properly
  • Documentation structure is logical and discoverable
  • No broken internal links

🤖 Generated with Claude Code

JnyJny and others added 2 commits August 12, 2025 15:17
- Move CLI_MIGRATION_EXAMPLE.md → docs/contributing/migration-guide.md
- Move LIGHT_SELECTION_GUIDE.md → docs/cli/selection-guide.md
- Move MANAGER_IMPROVEMENTS.md → docs/contributing/architecture-decisions.md
- Update mkdocs.yml navigation to include new CLI and Contributing subsections
- Add cross-references in CLI overview to new selection guide
- All documentation now properly organized under docs/ directory
- Exclude hardware device docs (migrating to busylight-core repo)

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <[email protected]>
- Combine Effects page from master with Contributing subsections
- Maintain proper navigation hierarchy with both Effects and enhanced Contributing sections
- All documentation builds successfully
@JnyJny JnyJny merged commit dc1958f into master Aug 12, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant