Repository navigation
Opens the README with an introduction - #208
Merged
Merged
Conversation
The README now opens with what the package is, why it exists, the install line, one basic-usage example in the library loan, a documentation map grouped by the reader's question (Learn, Do, Look up, Understand) and a compatibility section. The long sections stay below a "Reference, in full" heading, one level down, with their text unchanged except where an example taught in card processing or the signup wizard: those examples and their prose are re-cut in the library loan, with the same checks. The install block moves to the new Install section, and the Development section's pointer for engines.node now names Compatibility. Refs: pts-dvvy
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.
What this changes
The README now opens as an introduction and a map, and the reference it already carried follows it:
.claude/diataxis.md).pnpm add @riddler/predicator@^0.6.0line, moved up from the old Install section (still the one pin the release recipe moves).tsblock in the library loan (a renewal rule compiled once and evaluated against two loans). The README test runs and typechecks it like every other block.engines.nodefloor, module formats, TypeScript resolution modes and the instruction-set version, each taken from what the README andpackage.jsonalready say.Below a new
## Reference, in fullheading, every former section from "The entry points" through "Conformance" stays in place one heading level down, so every in-page anchor keeps working. The former Install text (the npm name's history and the engine runs) is there too, as "Installing, in full". The text is unchanged except for the re-cuts below. Development and License stay at the end as H2s.Example world
Every example and its surrounding prose that taught in card processing or the signup wizard is re-cut in the library loan: compiling a rule, running a rule from its text, rendering a rule back, evaluating an instruction list, the cyclic-context example and its paragraph, the unbound-load example, both statement-program examples, host functions, and the tagged subpath's binding name. Each check keeps its shape. The one value that moved is the refusal column in the draft-rule example, which follows the new draft string's length; the README test confirms it. The quoted
jsonblocks (conformance/SOURCE.jsonand the two registry claims) are untouched.Provenance
engines.node] is". That text is now under "Installing, in full", so the sentence names the Compatibility section instead, which states the floor.CLAUDE.mdsays an example already written in a fixture-only domain "stays as it is". This PR re-cuts the README's teaching examples anyway, under the bead's acceptance and the campaign consent's authorization of README changes in the example worlds the firewall rules. Fixtures, tests and corpus cases are not touched.Checks
mise exec -- pnpm run gate) green on this tree: typecheck, lint, neutrality, the suite with coverage (the README test included), corpus check, record cites, build, identity, resolution, typedoc.tsc --strictagainst@riddler/predicator@0.6.0installed from npm and run under node, completes.main.readme-lint.rb README.md --manifest .claude/diataxis.md:The one finding is the linter's Install rule, which recognises only a Hex dependency tuple. An npm install line cannot satisfy it. The length ceiling is not reported: the README is under the manifest's
readme_max_lines.src/changes. No changelog fragment:changelog.dexcludes documentation.Review
This PR is docs-only (tier: gate). I reviewed the text against the documentation rulebook's quadrant rules: the What and Why carry no history, the map is grouped by the reader's question, and each Documentation line names what the reader gets. The Learn links point at sections of this README that are reference-by-example rather than tutorials. That will stay true until tutorial pages exist.