Index of Millennium Helpers docs. make check-docs enforces that this index,
the project README Further reading table, and each guide’s
Related section stay cross-linked.
| Doc | Audience | Summary |
|---|---|---|
| licensing.md | Users & packagers | Helpers MIT + Millennium client MIT, vendored notice, upgrade behavior |
| mcp.md | Users | MCP server tools, registration with Claude / Cursor / Windsurf |
| security_troubleshooting.md | Users | Sudoers / Task Scheduler design, common failures |
| steam_deck.md | Users | Steam Deck (SteamOS) and Flatpak Steam hooks / overrides |
| uninstall_dryrun.md | Users | Dry-run mode and manual uninstall per install method |
| release_runbook.md | Maintainers | Cutting a vX.Y.Z release (preflight → tag → packaging) |
| Doc | Summary |
|---|---|
| README.md | Install, commands, config, further reading |
| CONTRIBUTING.md | Dev requirements, layout, versioning, packaging, licensing |
| packaging/README.md | from-source / bin / git packaging matrix (Arch, brew, Scoop, Nix, deb, rpm, Chocolatey) |
| SECURITY.md | Vulnerability reporting and security design overview |
| CHANGELOG.md | Release notes |
| LICENSE | Millennium Helpers MIT license |
| third_party/ | Vendored third-party notices (Millennium client) |
Installed with the helpers (man millennium, man millennium-diag, …). Each page
has a LICENSE section pointing at licensing.md; command-specific
pages also point at the matching guide where one exists (for example
millennium-mcp(1) → mcp.md).
- Add or rename a guide under
docs/→ update this index, README § Further reading, and topical Related footers. - Run
make check-docs(includes licensing checks; also part ofmake lint/make check-all).