Shanty/Main
1
0
Fork 0
Code Issues 18 Pull Requests Actions Packages Projects Releases Wiki Activity

Add comprehensive documentation #29

New Issue
Open
opened 2026-03-17 16:45:51 -04:00 by connor · 0 comments
connor commented 2026-03-17 16:45:51 -04:00
Owner
Copy Link

Write user-facing and developer-facing documentation for Shanty.

  1. User documentation:

    • Installation guide (from source, Docker, binary releases)
    • Configuration reference (all config options explained)
    • Quick start guide (get from zero to playing music)
    • FAQ

  2. Developer documentation:

    • Architecture overview (crate structure, data flow)
    • Contributing guide (how to set up the dev environment, coding standards, PR process)
    • API documentation (REST API reference for the web backend)

  3. Inline documentation:

    • Rustdoc comments on all public types and functions
    • cargo doc --workspace should produce useful documentation

Acceptance Criteria

  • README covers installation, quick start, and basic usage
  • Configuration reference documents all options
  • Architecture doc explains the crate structure and how they interact
  • Contributing guide exists
  • REST API is documented (consider using OpenAPI/Swagger)
  • cargo doc produces clean documentation with no warnings

Dependencies

  • Most other MVP issues (documentation should reflect implemented features)
Write user-facing and developer-facing documentation for Shanty. 1. **User documentation:** - Installation guide (from source, Docker, binary releases) - Configuration reference (all config options explained) - Quick start guide (get from zero to playing music) - FAQ 2. **Developer documentation:** - Architecture overview (crate structure, data flow) - Contributing guide (how to set up the dev environment, coding standards, PR process) - API documentation (REST API reference for the web backend) 3. **Inline documentation:** - Rustdoc comments on all public types and functions - `cargo doc --workspace` should produce useful documentation ### Acceptance Criteria - [ ] README covers installation, quick start, and basic usage - [ ] Configuration reference documents all options - [ ] Architecture doc explains the crate structure and how they interact - [ ] Contributing guide exists - [ ] REST API is documented (consider using OpenAPI/Swagger) - [ ] `cargo doc` produces clean documentation with no warnings ### Dependencies - Most other MVP issues (documentation should reflect implemented features)
connor added the MediumPriority label 2026-03-19 12:30:54 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
LowPriority
MediumPriority
HighPriority
MVP
No Label MediumPriority
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
connor
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Shanty/Main#29
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?