docs: simplify the README for first-time users - #114
Merged
Merged
Conversation
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.
Problem
The README mixed first-use instructions with compiler, proof and compatibility contracts. It also left the AI boundary unclear and named an old Wesper collector version. Closes #111.
Solution
Lead with a complete HTML-to-block example, explain the CLI/library/optional-skill relationship, and move detailed contracts into linked reference pages. The README is 145 lines, down from 607. Builds on #112 and #113; this PR contains only the README and its two reference documents.
docs/reference.mddocs/development.mdscripts/ci-scope.mjsand existing scriptsDiff
+638 −549 · 3 files · no runtime or API changes
The complete registered-block walkthrough remains in
skills/block-runner/references/AUTHORING.md, as established in #91. That file, the installed skill prompts and the package allowlist are unchanged.Testing & verification
Reviewed revision:
703d77209f26e1a176bc35a588b1d228f7158481· Environment: macOS, Node 22.23.1; engine-strict fresh consumer installed from the candidate tarball.npx --no-install block-runner convert hello.html— passed with the README's supplied input and exact output.npx --no-install block-runner convert hello.html --out hello.blocks.html— passed; file matches the shown output.npx --no-install block-runner convert hello.html --json— passed:ok: true, one valid block, zero invalid blocks and no warnings.node hello.mjs— passed using the README's library example; same block markup and empty findings.npx --no-install block-runner skill --install— passed; both documented discovery directories were created in the isolated consumer.npm run check:privateandnpm run pack:check— passed. Separately reviewed all five documentation files for private references becausedocs/is not packed.python3 /tmp/block-runner-docs-pass/check-links.py . README.md docs/reference.md docs/development.md docs/architecture.md docs/extending.md— passed, 76 candidate repository paths/anchors and zero failures. This local review utility is not a new repository dependency. Links to new main-branch documents become live when the stack merges.git diff codex/docs-architecture-110...HEAD --check— passed.npx vitest run dev/test/node-support.test.ts— passed, 4 tests. The install command retains the exact package engine range alongside the plain-language Node requirements.Not verified: human first-use/readability acceptance, fresh WordPress rendering or visual fidelity. The examples establish CLI/library/package behaviour, and the review establishes source consistency. GitHub CI passed on the reviewed revision: all three Node lanes, package-boundary, WordPress proof and the aggregate scope check. Run 34983974679. The additional packed custom-rule check and its duplicate class-token observation are recorded on #112.
Risk / rollout
Moving documentation can break navigation or separate a requirement from its explanation. Old README fragments now lead to the documentation table, with links to the corresponding detailed sections. The new guide links target the documentation added in #112 and #113.
Detection: check the retained anchors and linked contracts when editing these guides. Rollback: revert this PR's documentation commits. No website, dependency, generated template or release changes are included.
Authored by: GPT-6 via Codex.