docs: refresh site and README for post-v0.1.0 accuracy - #40
Merged
Conversation
- Drop stale "Available with the first tagged release" Homebrew phrasing now that v0.1.0 shipped (README, site homepage) - Clarify npm status: @timimsms/cu is a reserved placeholder only, no functional package published, no install command advertised - Note the go-install "dev" version caveat with a link to #36 - Cross-reference planned env-token fallback (#26) on the auth page - Enable content.action.edit so the configured edit_uri actually renders - Narrow deploy-docs path trigger to docs/site/** (design docs no longer trigger Pages deploys) - Pin mkdocs-material to 9.x in deploy and CI workflows Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Lands the verified accuracy fixes from the post-v0.1.0 documentation audits (live site + sources). Every claim was re-verified against the working tree before editing.
Fixes
Homebrew section: stale future tense (README.md:34, docs/site/index.md:32)
Audit evidence: live homepage and README still said "Available with the first tagged release." while
gh release view v0.1.0shows the release published 2026-07-15 with 5 platform archives + checksums.txt and the tap live.Fix: "Installs the latest tagged release from the timimsms/homebrew-cu tap."
npm section: placeholder status not conveyed (README.md:42, docs/site/index.md:42)
Audit evidence:
@timimsms/cuexists on npm as a 0.0.1 placeholder (name reserved); "Planned as@timimsms/cu(not yet published)" could mislead readers who find it on npm.Fix: states the name is reserved as a placeholder only, functional package not yet published; still no install command advertised.
go install "dev" version caveat (README.md, docs/site/index.md, under the Go install block)
Audit evidence: Makefile injects version via -ldflags only in make/goreleaser builds; a fresh
go buildfrom main reportscu version dev(open issue version: fall back to debug.ReadBuildInfo() so 'go install' builds report their real version #36).Fix: one-line note linking version: fall back to debug.ReadBuildInfo() so 'go install' builds report their real version #36.
Auth page: env-fallback cross-reference (docs/site/authentication.md:39)
Audit evidence: "no environment-variable fallback" is accurate today (only os.Getenv in the tree is HOME) but reads as permanent; issue auth: support CU_API_TOKEN env fallback for headless/CI authentication #26 (open) tracks the planned fallback.
Fix: appended "An environment-variable token fallback is planned — see issue auth: support CU_API_TOKEN env fallback for headless/CI authentication #26."
Edit pencil never renders (mkdocs.yml)
Audit evidence:
edit_uri: edit/main/docs/site/is set but theme.features lackedcontent.action.edit, so live HTML contains zero edit links (grep count 0). Verified locally: after adding the feature, the built index.html contains the edit link (grep count 1).Fix: added
content.action.editto theme.features.Deploy trigger broader than the published site (.github/workflows/deploy-docs.yml)
Audit evidence: paths included
docs/**while docs_dir isdocs/site; run 29550158962 was triggered by PR docs: add context-layer design spec (refs, aliases, packs, onboard, pickers) #39 whose only file was docs/design/context-layer.md (intentionally unpublished).Fix: narrowed to
docs/site/**(mkdocs.yml and the workflow file remain triggers).mkdocs-material unpinned (.github/workflows/deploy-docs.yml:36, .github/workflows/ci.yml:133)
Audit evidence:
pip install mkdocs-materialwith no constraint +--strictbuilds; Material's MkDocs 2.0 advisory banner warns of upcoming breaking changes.Fix: pinned to
'mkdocs-material==9.*'in both workflows.Deliberately not included
cu docs markdown; all 45 regenerated pages are byte-identical to docs/site/commands/ except the cobra footer-date line (0 non-footer diff lines). The live audit's "content drift" claim did not reproduce; regenerating would be 45 files of footer-date churn for zero content value.Verification
mkdocs build --strictin a scratch venv (mkdocs 1.6.1, mkdocs-material 9.x): exit 0, no warnings.🤖 Generated with Claude Code