docs: prepare repository for public launch - #33
Merged
Conversation
- README: add unofficial-project disclaimer; fix install instructions (Homebrew tap timimsms/cu/cu, go install, npm planned as @timimsms/cu, correct releases link) - docs/site/index.md: mirror install fixes and disclaimer - Add CONTRIBUTING.md, SECURITY.md, issue and PR templates - auth: remove inaccurate OAuth claims from command help (token-only) - Regenerate cu auth command docs to match - Add Authentication & Security docs page and nav entry - mkdocs: fix edit_uri to point at docs/site/ - deploy-docs workflow: build with --strict 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
1 participant
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.
Summary
Prepares the repository for public launch:
brew install timimsms/cu/cu(macOS, live with the first tagged release), addsgo install github.com/timimsms/cu/cmd/cu@latest, notes npm is planned as@timimsms/cu(not yet published), and fixes the releases link.CONTRIBUTING.md(dev setup, conventional commits, tests, docs regeneration, mkdocs preview),SECURITY.md(keychain-based token storage, revocation, private vulnerability reporting), issue templates, and a PR template.cu auth/cu auth loginhelp text (token-only is what exists) and regenerates the two affected command docs. Footer-only regeneration noise on the other 43 command docs was reverted.docs/site/authentication.md(Authentication & Security — token creation, per-OS storage, headless Linux caveat, revocation), added to the mkdocs nav.edit_uritoedit/main/docs/site/(docs_dir isdocs/site); deploy workflow now builds with--strict.Merge Order
This PR should merge AFTER the module-rename PR (
github.com/tim/cu→github.com/timimsms/cu), since the README/docs referencego install github.com/timimsms/cu/cmd/cu@latest, which is only valid once the module path is renamed.Verification
mkdocs build --strictpasses (mkdocs-material)go build ./...andgo test ./...pass🤖 Generated with Claude Code