docs: rework the landing pages and fix inaccuracies - #4
Merged
Conversation
Rewrite the README and the docs index around the screenshot, a one-line pitch and the project badges, and move the prose that repeated itself into a single paragraph under a rule. Fix what the pages got wrong about the shell: - the scan cycle referred to a bare `scan`, which is a namespace rather than a command - the watch pages said Ctrl+C leaves the shell; it ends the running command and returns to the prompt - PICKLOCK_CONFIG_DIR was called a flag Also fix a broken sentence in the pointers guide. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
github-actions
Bot
added
the
docs
Docs-only release. The quickstart's banner sample and the Sphinx fallback carry the version literally, so both move with it. Co-Authored-By: Claude Opus 5 (1M context) <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.
What
Reworks the two landing pages (
README.mdanddocs/index.md) and fixes ahandful of statements elsewhere in the docs that did not match the shell.
Landing pages
badges (CI, PyPI, licence, Python version), with the prose that used to
repeat itself collapsed into a single paragraph under a rule.
Corrections
docs/index.mdscanto search memory"scanis a namespace, not a command — the text now points at thescancommandsdocs/guide/reading-writing.md,docs/troubleshooting.mdshell.py), so the claim is droppeddocs/guide/aliases-and-config.mdPICKLOCK_CONFIG_DIRcalled "the flag"docs/guide/pointers.mdREADME.mdwritting,dependancyAlso
docs/installation.md: the "From source" section is now just the clone —the development setup lives in
CONTRIBUTING.md.docs/funding.md: drops the second star request, matching the README.Version
Bumped to 0.1.1 (patch — docs only).
picklock/__init__.pyis the singlesource hatch reads;
docs/quickstart.mdand the Sphinx fallback indocs/conf.pyspell the version out literally, so they move with it.Checks
sphinx-buildruns clean, no warnings, and every cross-reference resolves.scripts/generate_command_reference.pyoutput is unchanged, so the commandreference still matches the registry.
against the code.
🤖 Generated with Claude Code