Add a documentation site, and reduce the README to a landing page - #38
Merged
Conversation
The README had grown to hold everything there is to know about keycmd,
which made the one thing a landing page is for -- seeing what this is and
getting a first command to run -- the hardest thing to find in it.
This moves the prose into an mkdocs-material site under docs/, arranged
the way a command line tool is used rather than the way a library is
read: getting started, then a guide per subject (running commands,
configuration, keyring backends, WSL, troubleshooting), then the two
worked examples, then a reference for every flag, environment variable
and configuration field, and the development notes last.
Every section of the README has a home:
- About, Quickstart -> index, getting-started/
- Installation, pyenv, upgrading -> getting-started/installation
- WSL installation -> guide/wsl, which now covers both the
install and the boundary in one place
- Usage -> guide/running-commands, reference/cli
- Configuration -> guide/configuration,
reference/configuration
- OpenAI, Advanced example -> examples/
- Debugging configuration -> guide/troubleshooting, which also
collects the errors keycmd can print
- Note on keyring backends -> guide/keyring-backends
- Development, Testing -> development/
The screenshots move to docs/assets/ so that docs/ is the site root.
The site builds with --strict on every pull request and deploys to GitHub
Pages on every push to master, so a broken link or a page missing from the
nav fails before it lands. Pages has to be set to build from GitHub
Actions in the repository settings for the deploy to work.
The WSL hint that keycmd prints when a distribution has no keyring daemon
pointed at the README, which no longer explains that; it points at the WSL
page now.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013WGd3CZCxGfnzdgXggWgWA
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.
The README had grown to hold everything there is to know about keycmd, which made the one thing a landing page is for — seeing what this is and getting a first command to run — the hardest thing to find in it.
This moves the prose into an mkdocs-material site under
docs/, arranged the way a command line tool is used rather than the way a library is read: no API reference and no mkdocstrings, and a reference section that is flags, environment variables, files and exit status instead.Where each README section went
index.md,getting-started/getting-started/installation.mdguide/wsl.md, which covers the install and the boundary in one placeguide/running-commands.md,reference/cli.mdguide/configuration.md,reference/configuration.mdexamples/guide/troubleshooting.mdguide/keyring-backends.mddevelopment/Beyond re-homing, troubleshooting gained a "common problems" section keyed on the error strings keycmd actually prints (
MISSING credential ...,MISSING alias key ..., no backend, the unquoted$SECRETmistake), and the platform and shell variants use tabs rather than stacked headings. The screenshots move todocs/assets/so thatdocs/is the site root.The README is now roughly seventy lines: badges, a paragraph of pitch, install and config and run, five bullets on why, and a table of links into the site. Its CI badge pointed at
clinicalgraphics/keycmdand now points here.Supporting changes
.github/workflows/docs.ymlbuilds with--stricton pull requests, so a broken link or a page missing from the nav fails before it lands, and deploys to GitHub Pages on push tomaster.docsdependency group, aDocumentationproject URL,sitein.gitignore, and the docs commands and conventions inCLAUDE.md.Before merging
GitHub Pages has to be set to build from GitHub Actions in the repository settings, or the deploy job fails on its first run. The site URL is assumed to be
korijn.github.io/keycmd, which is baked intomkdocs.yml, the README links and that error hint.Verification
mkdocs build --strictclean,ruff check/ruff format --checkclean,ty check --error-on-warningclean, and 156 passed / 16 skipped — the skips being the OS keyring and WSL tests this container cannot provide for.Generated by Claude Code