Repository navigation
Rewrites the README as an introduction - #44
Merged
Merged
Conversation
The README now reads as an introduction and a map: what the package is, why it exists, how to install it, one basic-usage example and links to the rest grouped by the reader's question, then compatibility. The example is a library loan, a doctest the README test still runs. The per-function walk, "What is not here" and "Who takes this" leave the README; the module documentation on hexdocs already carries their substance, and the map links each module page. Refs: sd-pwh
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 becomes an introduction and a map: a What under the title, a Why, Install, one Basic usage example, a Documentation section grouped by the reader's question (Learn, Do, Look up, Understand) and Compatibility. It ends at 117 lines, down from 414.
What changed
{:statifier_datamodel, "~> 0.5.0"}. The repo's release extension (.claude/wurk/release.md, "The README install pin: write the.0form") requires the exact-minor.0form, and that is the current minor.iex>block (26 lines) in the library loan: a document with alibrary.loanrecord and aRenewableshape, indexed, the type at a path read out and handed to the read check, which names the optionalrenewalsfield as missing, and an undeclared path answering:unknown.mix.exs, no runtime dependencies, and the pre-1.0 policy that used to sit as a banner above the introduction.test/readme_test.exsstill runsdoctest_file("README.md"); only its moduledoc changes, since the README is no longer the per-function reference.Unchanged except: the H2s
Installation(nowInstall),What it answers,What is not hereandWho takes thisare removed;Why this package,Basic usage,DocumentationandCompatibilityare added;Licensestays. The removed sections' substance is already in the module documentation the map links: the per-function walk in each module's moduledoc, "What is not here" in the root module's moduledoc, and "Who takes this" is covered by the Why. The card-processing examples go with them, so no example in a fixture-only domain remains in the README.Checks
mix quality(full) green on this tree: format, compile, credo, docs, doc links, dependencies, dialyzer, 137 of 137 tests at 99.1% coverage. The commit is the tree that run read, with the gate lock and a machine slot held across both.{:missing, ["renewals"]}and the final expected:unknowneach turneddoctest README.md (1)red on the assertion.readme-lint.rb README.md --manifest .claude/diataxis.md:README.md: 117 lines, every part present(exit 0).readme-lint.rb README.md(no manifest):README.md: 117 lines, every part present(exit 0).lib/changes.The README stage flip
ex_quality 0.16.0 is not on Hex (latest 0.15.1), so this PR takes the acceptance's fallback: the ex_quality dev dependency stays at
~> 0.15and.quality.exsis not edited. Enabling the README stage at error is left for a follow-up once 0.16.0 is published.Provenance
.0form the release extension prescribes rather than the bare~> 0.5form.Review
In-turn review of the text (this tier takes no conductor-dispatched code review): every Documentation link lands on a module page or a GitHub path that exists; the Do links say they point at the API reference until a guide page exists; no divider heading reclassifies sections; the What's claims ("what the document alone can settle") match the root module's moduledoc; both packages the Why names depend on this one on their main branches; the introduction carries no contributor-only text and no avoided term.