Repository navigation
M9: rewrite the README and the docs for v0.3.0 - #28
Merged
Merged
Conversation
Both were thoroughly v0.2.0. They documented --cookies, --workers, a singular quote command, crawl --parse, search --html and a five row exit code table that has not been right since M4, and they said nothing about works, editions, the graph, the crawler or the MCP server. Everything is one sentence per line, with no newline inside a sentence, so a one word change is a one line diff. The guides are renamed to the job they cover rather than the commands that happened to exist in v0.1.0: books-and-authors -> books-and-works search-and-discovery -> store-and-graph shelves-and-quotes -> robots-and-limits bulk-crawling -> crawling (new) mcp v0-1-0.md keeps its facts and gains a note saying they are v0.1.0's, so somebody landing on it from a search does not follow it into --cookies. The root command's Long text was stale in the same way, naming search, shelves and reviews as the headline and saying nothing about the line robots.txt draws, so it says that now instead.
5 of 7 tasks
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.
Closes the first two boxes of #17.
The README and everything under
docs/were thoroughly v0.2.0. They documented--cookies,--workers, a singularquotecommand,crawl --parse,search --htmland a five row exit code table that has not been right since M4, and they said nothing at all about works, editions, the graph, the crawler or the MCP server.Everything here is one sentence per line with no newline inside a sentence, so a one word change is a one line diff rather than a reflow.
Renames
The guides were named after the commands that happened to exist in v0.1.0. They are now named after the job:
books-and-authors.mdbooks-and-works.mdsearch-and-discovery.mdstore-and-graph.mdshelves-and-quotes.mdrobots-and-limits.mdbulk-crawling.mdcrawling.mdmcp.md, newWhat is new in the content
og:tags, so a selector there is not a shortcut.robots.txtas its own guide: what is disallowed, what you lose, the two real routes around, and the four deliberate properties of--no-robots.--no-robotsand why that is enforced by a test rather than by a paragraph.gr:URI, the twelve predicates with their properties, and the SQL you can actually run.cli/root.go.release-notes/v0-3-0.md, with a breaking-changes section naming every flag and command that moved.v0-1-0.mdkeeps its facts and gains a note at the top saying they are v0.1.0's, so somebody landing on it from a search does not follow it into--cookies.One code change
cli/root.go'sLongwas stale in the same way as the docs. It named search, shelves and reviews as the headline and said nothing about the linerobots.txtdraws, so it says that instead.Checked
Every command, flag and default in the reference was read off
goodread <command> --helpfrom a build of this branch rather than remembered. The book table output in the README and the quick start is a real run. The--templateexamples are real too, which is how the note about--fieldsnaming JSON keys and--templatewalking the Go struct got written:{{.title}}does not work and it is not obvious why.gofmt -l . && go vet ./... && go test ./...is clean.