Repository navigation
docs: rewrite the README for a reader deciding whether to use the package - #23
Merged
Merged
Conversation
…kage The README now leads with a real verdict (two package versions in, canonical JSON out), then install through the flake, the verdict, the status and a user FAQ. The front-end detail moves to docs/front-ends.md, and the development setup, profile reproduction and provenance move to CONTRIBUTING.md. Claims were checked against the source, the manifests and a run of the example.
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.
Replaces #21, which was closed. This branch starts from a fresh worktree off
origin/main, and the three files below were staged by name; the staged diff held no.sfs-deps/,.deps/or*.tgzpath.Files
README.md: rewritten.docs/front-ends.md: new. The front-end detail moved verbatim from the old README (one link made relative todocs/).CONTRIBUTING.md: new. The development setup, the profile reproduction steps and the provenance paragraph moved from the old README.How it was written (write-readme-md)
Shape: library, in a flagship monorepo, so the root is the product README with a short map of the private apps. References opened:
readme-library.md,readme-monorepo.md,structure.md,readme-root-design.md,readme-templates.md.The README leads with a real verdict. I wrote two versions of a small package (a function whose
Echannel gains aTimeout), ranFrontEnd.readPackage,FrontEnd.analyseandVerdict.cell.runin this repository's workspace, and pasted the output verbatim (major,E_WIDENEDandEXPORT_ADDED, corpus 1.1.0). The scratch script and fixtures were deleted afterwards.Other claims checked against the repo: Node
>=24and theeffect^4.1.2peer (packages/api-extractor/package.json); 61 rules over 33 change kinds and the four E-channel rules (corpus.v1.json); the flake exposesapi-extractorandworkspace-tarballs; no workflow here pushes to the registry, so the Install section says Nix builds this package from source;v0.1.0is the latest GitHub Release and its changelog names the front-ends. Install goes through the flake and the pnpm-release-management route, never npm.Scripts
score_readme.ts: 6/13 (sections, contributing, relative links, tables pass; prose density 4.48 words per line and the emoji, details and blockquote criteria do not).triage_readme.ts: one tier-3 finding, that the two badge images are not theme-aware. Rendered through GitHub's markdown API in Chromium in light and dark, both badges load (66x20 and 78x20) and the h1 and positioning sentence sit above 130px. A first run also flagged a flat heading hierarchy (tier 2); subsections were added and it cleared.check_mechanisms.ts: one finding,Example, which is a false positive. The script judges design references, and it matchedmustinside the verdict's ownnext_actiontext, quoted verbatim from real output.