Skip to content

DOCS: Production documentation for v1.0 #10

@dyoung522

Description

@dyoung522

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 overview
  • lmm-install(1) - Install command details
  • lmm-profile(1) - Profile management
  • lmm-update(1) - Update management
  • lmm-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 settings
  • games.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 --help text for all commands and flags
  • Exit codes documented: 0=success, 1=error, 2=user cancelled
  • Color output with --no-color flag and NO_COLOR env var support

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions