Repository navigation
docs: rewrite the README as a front page for people deciding to use it - #21
Closed
systemfsoftware-maker wants to merge 2 commits into
Closed
systemfsoftware-maker wants to merge 2 commits into
systemfsoftware-maker wants to merge 2 commits into
Conversation
The pitch, status and install route come first, then the verdict and reading a package. The front-end detail moves to docs/front-ends.md and the development setup and provenance to CONTRIBUTING.md. Each claim was checked against the source.
# Conflicts: # README.md
Contributor
|
Closed: it adds back 34 |
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.
Rewrites the README for a reader deciding whether to use the package: what it is, status, install route, the verdict, and reading a package's API.
docs/front-ends.md(35 sentences, all from the old README apart from a two-line intro).CONTRIBUTING.md.Claims checked against the source
Verdict.cell,Verdict.judge,ApiModel.serialise,FrontEnd.readPackage,analyse,isolatedEmitterLayer,compilerEmitterLayer,SurfaceRejected,RuleCorpusRejectedare exported frompackages/api-extractor/src/mod.tsand its namespaces.verdict.schema.tsandfinding.schema.ts; the three Effect-channel examples (E_WIDENEDmajor,E_WIDENED_IN_INPUTminor,E_TAG_REMOVEDmajor) matchcorpus.v1.json.NodeServicesimported from@effect/platform-nodeas the package's own integration tests do.bootstrap,test,lint,typecheckexist in the rootpackage.json; the oracle version and commit matchLICENSE.nix.systemfsoftware.comworkflow onmainand publishes no npm package (release.yml), so the README says that a consumer takes the flake and the tarballs through the producer route, and that Nix fetches what a producer has pushed and builds the rest.No code changes.