fix(config): --config help advertised a filename the code never writes - #47
Conversation
The flag help said $HOME/.config/cu/config.yml, but ConfigType is "yaml", so Save writes config.yaml. Cosmetic, but it is the documented path for a file users are told to edit by hand. Regenerating the CLI docs touches every command page, since --config is a global flag rendered into each one. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014aqbmccWm1tqttmBUCR5rv ClickUp: 86dxbeqyt
Review — approve, no blockersCorrect fix, and the diff-size explanation checks out. I verified the doc churn is exactly what's claimed — every changed line across all 50 pages collapses to two forms plus the datestamp: No page carries an unrelated edit hiding in the noise. I also regenerated the docs from the branch binary into a scratch directory and diffed against the committed tree with datestamps normalized — byte-identical, all 50 files. So trimming the datestamp-only pages didn't leave the committed docs out of sync with what the generator actually produces, which was the one thing worth checking about that decision. Nothing in CI verifies doc freshness either (the Worth saying the fix is more than cosmetic: the two filenames are not interchangeable once one exists, and |
Summary
The
--configflag help advertised$HOME/.config/cu/config.yml, butConfigTypeis"yaml", soSavewritesconfig.yaml. Cosmetic, but it is the documented path for a file users are told to edit by hand — and the two files are not interchangeable once one exists.Note on the diff size
One line of Go, 50 documentation pages.
--configis a persistent root flag, so cobra renders it into every command's Global Flags block; regenerating withcu docs markdownupdates all of them. Every doc diff is that single line plus the generator's datestamp — pages whose only change was the datestamp were reverted to keep the diff readable.Checklist
./scripts/ci.shpasses locally — excepterrcheck, which reports the same pre-existing findings onmain, none in files this PR touchescu docs markdown --dir docs/site/commands)