Repository navigation
docs(repo): document setup and usage - #7
Merged
systemfsoftware-bot merged 1 commit intoNov 6, 2026
Merged
systemfsoftware-bot merged 1 commit into
systemfsoftware-bot merged 1 commit into
Conversation
|
@Mergifyio queue |
|
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.
Summary
Readers can find the packages, build local tarballs, and scaffold a suite without relying on unpublished effect-e2e packages. Contributors have checkout setup instructions for the pinned core tarballs.
This is the independent README and setup slice. Constitution import and locked instruction-file changes remain outside this PR; the overall issue remains open.
Related to SYS-1165
Verification
./bin/dprint check README.md CONTRIBUTING.md— passed.Installed
write-readme-mdscorer,deno run --allow-read <skill>/scripts/score_readme.ts README.md(skill path normalized) — 5/13. The workflow was applied using the monorepo and library references; passing criteria weresections_5,sections_3,contributing,relative_links, andrelative_links_3.In a fresh consumer directory, the README's install and scaffold commands ran from the repository checkout:
The three installs reported
added 2 packages in 707ms,added 37 packages in 3s, andadded 14 packages in 2s. The scaffold reported the following; the temporary directory is redacted:In a clean source clone at
4602aa56734ded471abae96473c6570bfd2b0df8, both contributor setup commands exited 0:The first produced no output.
pnpm installreportedPackages: +515,reused 515, downloaded 0, successfuleffect-tsgo patch, andDone in 2s using pnpm v12.9.0. Git status was clean before and after; this was a warm-store install, not a cold or offline verification.The generated suite and API-consumer example were not run. An earlier API interpreter invocation was refused; no passing result is claimed. Registry queries for the three effect-e2e packages returned 404; the example uses local tarballs.
pnpm check:localis required by the repository gate but is prohibited locally by OP28; it remains pending off-host evidence. No CI or main-check result is claimed here.