-
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Production Documentation
Priority: Ongoing | Phase: Throughout | Milestone: v1.0 MVP
Comprehensive documentation for v1.0 release.
When to Work On
- Document each feature as it's completed
- Final documentation pass before v1.0 release
- Can be done in parallel with development
Deliverables
Man Pages
Generate man pages for all commands:
lmm(1)- Main command overviewlmm-install(1)- Install command detailslmm-profile(1)- Profile managementlmm-update(1)- Update managementlmm-import(1)- Local import (new)lmm-verify(1)- Checksum verification (new)- etc.
Consider using go-md2man or similar tool.
Configuration Reference
Document all options in:
config.yaml- Global settingsgames.yaml- Game definitions (including hooks)- Profile YAML format
CONTRIBUTING.md
- How to contribute
- Code style guidelines
- Testing requirements
- PR process
README Updates
- Document all new v1.0 features
- Update CLI reference table
- Add examples for new commands
CLI Polish
- Consistent error messages with actionable hints
- Complete
--helptext for all commands and flags - Exit codes documented: 0=success, 1=error, 2=user cancelled
- Color output with
--no-colorflag andNO_COLORenv var support
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation