Skip to content

docs(repo): document setup and usage - #7

Merged
systemfsoftware-bot merged 1 commit into
mainfrom
ryan/sys-1165-effect-e2e-deliver-repo-specific-readme-and-extracted-repo
Nov 6, 2026
Merged

systemfsoftware-bot merged 1 commit into
mainfrom
ryan/sys-1165-effect-e2e-deliver-repo-specific-readme-and-extracted-repo

Conversation

@systemfsoftware-maker

Copy link
Copy Markdown
Contributor

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-md scorer, 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 were sections_5, sections_3, contributing, relative_links, and relative_links_3.

  • In a fresh consumer directory, the README's install and scaffold commands ran from the repository checkout:

    consumer="$(mktemp -d)"
    core="$(nix build --no-link --print-out-paths .#sfs-deps)"
    runtime="$(nix build --no-link --print-out-paths .#effect-e2e)"
    cli="$(nix build --no-link --print-out-paths .#effect-e2e-cli)"
    npm install --prefix "$consumer" --no-audit --no-fund "$core/effect-cell-types-12.0.2.tgz" effect@4.1.2
    npm install --prefix "$consumer" --no-audit --no-fund "$runtime"
    npm install --prefix "$consumer" --no-audit --no-fund "$cli"
    "$consumer/node_modules/.bin/effect-e2e" init --dir "$consumer/demo" --engine web --gateway openrouter --no-install

    The three installs reported added 2 packages in 707ms, added 37 packages in 3s, and added 14 packages in 2s. The scaffold reported the following; the temporary directory is redacted:

    effect-e2e init: scaffolding demo in <consumer>/demo
      wrote e2e.config.ts
      wrote vitest.config.ts
      wrote runner.ts
      wrote global-setup.ts
      wrote tests/example.e2e.ts
      wrote tests/example-agent.e2e.ts
      wrote package.json
      wrote .gitignore
    Run the suite with its test:e2e script from <consumer>/demo
    
  • In a clean source clone at 4602aa56734ded471abae96473c6570bfd2b0df8, both contributor setup commands exited 0:

    mkdir -p .sfs-deps && cp -L --no-preserve=mode "$(nix build --no-link --print-out-paths .#sfs-deps)"/*.tgz .sfs-deps/
    pnpm install

    The first produced no output. pnpm install reported Packages: +515, reused 515, downloaded 0, successful effect-tsgo patch, and Done 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:local is 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.

@kiro-systemf

kiro-systemf Bot commented Nov 6, 2026

Copy link
Copy Markdown

@Mergifyio queue

@mergify

mergify Bot commented Nov 6, 2026

Copy link
Copy Markdown

queue

⚠️ Cannot use the command queue

Details

⚠ The product Merge Queue needs to be activated to enable this feature.

@systemfsoftware-bot
systemfsoftware-bot merged commit 5989c4f into main Nov 6, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants