docs: polish CLI documentation wording and fix stale references#286
Conversation
Editorial pass across the user- and contributor-facing docs to improve clarity and readability while keeping all commands, flags, config keys, tables, and examples intact. Also fixes three factual errors verified against the code: - docs/CC_STATUSLINE.md referenced `shelltime daemon start` (no such subcommand); replaced with `shelltime daemon install`. - docs/CONFIG.md told users to start the daemon via the bare `shelltime-daemon` binary; replaced with `shelltime daemon install`. - CLAUDE.md listed `config.toml` as the main config; the loader prefers YAML, so it now reads `config.yaml` (TOML still accepted). Also unifies the .goreleaser.yaml release-notes install command to the short `https://shelltime.xyz/i` URL used by the README. Co-Authored-By: Claude Opus 4.8 (1M context) <[email protected]>
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation, README, and configuration guides across the repository to improve clarity, update installation instructions, and reflect the transition from TOML to YAML as the preferred configuration format. It also standardizes the daemon installation command to shelltime daemon install. There are no review comments to address, and no feedback is provided.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
1 participant
Summary
Editorial polish across the user- and contributor-facing docs to improve clarity and readability, while keeping every command, flag, config key, table, and example intact. Along the way, fixes three factual errors verified against the actual code.
Files touched
README.md— tightened intro/pitch, moved the contributor-onlymalamtime↔ShellTimemodule note out of the opening paragraph into a footnote under Development, smoothed What ShellTime Does, Quick Start, Daemon Mode, and Security and Privacy.docs/CONFIG.md— reworked intro and a few awkward sentences.docs/CC_STATUSLINE.md— clearer overview, requirements, and performance phrasing.AGENTS.md/CLAUDE.md— light copyedits; all behavioral instructions preserved..goreleaser.yaml— fixed release-notes header grammar and lightly polished the footer and Homebrew caveats. Build config (builds,archives,ldflags,notarize) untouched.Correctness fixes (verified against code)
docs/CC_STATUSLINE.mdreferencedshelltime daemon start— no such subcommand exists →shelltime daemon install.docs/CONFIG.mdtold users to start the daemon via the bareshelltime-daemonbinary →shelltime daemon install.CLAUDE.mdlistedconfig.tomlas the main config, but the loader (model/config.go) prefers YAML → nowconfig.yaml(TOML still accepted)..goreleaser.yamlrelease-notes install command to the shorthttps://shelltime.xyz/iURL the README already uses.Verification
go build ./...passes.goreleaser checkreports the config is valid (only pre-existing deprecation warnings, unrelated to this change).daemon startreferences remain and the install URLs are now consistent.🤖 Generated with Claude Code