Skip to content

docs(root-readme): meta-framework landing README (PR3)#118

Merged
rickylabs merged 11 commits into
mainfrom
docs/root-readme
Jun 24, 2026
Merged

docs(root-readme): meta-framework landing README (PR3)#118
rickylabs merged 11 commits into
mainfrom
docs/root-readme

Conversation

@rickylabs

Copy link
Copy Markdown
Owner

PR3 — Root repository README (meta-framework landing page)

Final docs PR of the road to JSR publish topology:

Pipeline (harness-gated)

  1. Deep search (Gemini-3.5-Flash, OpenHands) → .llm/tmp/run/docs-root-readme/sota-landing-dossier.md — NetScript-specific framework-landing research, seeded by the prior Track-2 dossier, grounded in the authoritative 31-package map + merged package READMEs.
  2. Plan → PLAN-EVAL (OpenHands minimax-M3, separate session).
  3. Author (Claude documentation-authoring workflow) → root README.
  4. IMPL-EVAL (OpenHands qwen3.7-max, separate session) → merge.
  5. Then: publish:dry-run green → release tag → OIDC deno publish.

Status: draft — deep-search dispatch in progress.

🤖 Generated with Claude Code

Scaffolds PR3 (root README) on its own branch off main (post PR1+PR2). The brief
dispatches a fresh Gemini-3.5-Flash landing-README deep search into PR3's own run
folder (.llm/tmp/run/docs-root-readme/), seeded by the existing Track-2 dossier and
grounded in the authoritative 31-package map + the merged package READMEs.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
@rickylabs

Copy link
Copy Markdown
Owner Author

@openhands-agent model=openrouter/google/gemini-3.5-flash provider=openrouter output=pr-comment iterations=1000

use harness

PR3 Deep-Search Dispatch — NetScript ROOT README (framework-landing) research

You are a research agent (OpenHands, openrouter/google/gemini-3.5-flash, web-browsing). Your
job is to produce a single, NetScript-specific dossier that grounds the authoring of the root
repository README.md
— the front door / landing page for the whole NetScript meta-framework.
This is PR3 of the "road to JSR publish" program; the bar is stunning, enterprise-grade, and
truthful
. You are NOT authoring the README here — produce research, skeletons, and a checklist.

SKILL

Activate and follow these repo skills before researching (read each SKILL.md; mandatory):

  • .agents/skills/netscript-harness — harness run-artifact contract; where research lands; voice
    doctrine. You are the Research phase of a harnessed run.
  • .agents/skills/jsr-audit — JSR rendering rules: what raw HTML/markdown survives the JSR registry
    renderer vs. GitHub-only devices (the root README also renders on the repo's JSR scope page).
  • .agents/skills/netscript-doctrine — the package/plugin archetypes and the true public surface,
    so the landing page's architecture story and package map are accurate, not invented.
  • .agents/skills/netscript-deno-toolchaindeno doc to ground-truth any API/command claim you
    recommend surfacing on the landing page (e.g. the @netscript/cli scaffold command).

What already exists (read FIRST, then go deeper — do NOT redo it)

A prior dual-track dossier lives at
.llm/tmp/run/docs-readme-revamp/sota-readme-dossier.md. Its Track 2 — Best-in-Class Monorepo /
Framework Landing READMEs
already analysed 10 exemplars (Astro, Next.js, Remix, Hono, Bun, NestJS,
Turborepo, Medusa, Payload, Deno), a canonical framework-landing skeleton, 3 hero options, a
visual-design + JSR-compat toolkit, and landing anti-patterns. Treat Track 2 as your seed/baseline.
Your mandate is to go BEYOND it in three NetScript-specific directions it did not cover:

  1. NetScript-specific competitor head-to-head. Track 2 surveyed famous frameworks generically.
    Now research the closest-positioned projects to NetScript — a Deno-native, JSR-published,
    plugin-architecture meta-framework over Hono + oRPC + Fresh with first-party workers/sagas/
    triggers/streams/auth plugins and .NET Aspire deployment. Study how these in particular present
    a composable, plugin-centric, multi-runtime backend framework on their landing page:
    Encore (encore.dev), Wasp (wasp-lang.dev), RedwoodJS, AdonisJS, Medusa, Nitro/UnJS, Hono,
    Fresh (deno), Nx, Turborepo, Effect, Modern monorepo "platform" repos.
    For each, capture what
    makes a plugin/composable-backend story land: how they show the plugin/module ecosystem, how
    they draw the architecture, how they sequence "what is it → why → 60-second start → architecture
    → package map → docs". Cite URLs and quote the specific device.

  2. Architecture-diagram treatment for THIS stack. NetScript's defining hook is the plugin
    composition over Hono(router)+oRPC(typed procedures)+Fresh(UI)+Aspire(orchestration), with
    first-party plugins (auth, workers, sagas, triggers, streams) and *-core contract packages.
    Research how top framework READMEs render an architecture mental-model that renders on BOTH GitHub
    and JSR (ASCII vs. image vs. mermaid — note mermaid renders on GitHub but is stripped on JSR).
    Propose 2–3 concrete architecture-diagram options for NetScript specifically, with the
    GitHub-vs-JSR rendering trade-off stated for each.

  3. Ground-truth package map. The landing page's monorepo table must use the REAL 31 published
    packages (below — authoritative, all 0.0.1-alpha.1). Track 2's table invented names/blurbs; do
    not reuse it. Recommend how to GROUP these 31 into a scannable table (by layer: foundation /
    data / runtime plugins / *-core contracts / auth backends / app-surface) rather than a flat
    31-row dump, and design the column set (package · one-line · JSR badge · reference-docs link).

Authoritative package map (ground truth — use these exact names/descriptions)

@netscript/contracts        — contract primitives, common schemas, CRUD generators, query/transform helpers
@netscript/config           — typed project config schemas, loaders, env helpers, scaffold constants
@netscript/logger           — structured logging for services/packages/workers/Hono+oRPC
@netscript/sdk              — service discovery, oRPC clients, cache-backed query factories
@netscript/runtime-config   — hot-reloadable runtime override types, loaders, watchers, diagnostics
@netscript/telemetry        — OpenTelemetry tracing for jobs, queues, RPC, SSE
@netscript/kv               — reactive key-value abstraction (Redis, Deno KV, in-memory)
@netscript/database         — DB adapter contracts, Prisma driver helpers, tracing, schema tooling
@netscript/prisma-adapter-mysql — Prisma driver adapter for MySQL/MariaDB on Deno
@netscript/queue            — provider-agnostic message queue (Fedify adapters: Deno KV, Redis, RabbitMQ)
@netscript/cron             — runtime-agnostic cron scheduling abstraction for Deno
@netscript/watchers         — composable file-watching runtime (strategies, filters, stability, stop)
@netscript/plugin           — plugin manifest, validation, discovery, host-context contracts
@netscript/plugin-auth-core — auth plugin contracts, backend ports, stream/config schemas, testing primitives
@netscript/plugin-workers-core  — job/task/workflow/runtime/config/testing primitives for workers
@netscript/plugin-sagas-core    — saga DSL, runtime ports, adapters, telemetry, config, testing primitives
@netscript/plugin-triggers-core — trigger DSL, runtime ports, adapters, telemetry, config, testing primitives
@netscript/plugin-streams-core  — schema/producer/config/telemetry/testing/diagnostics primitives for streams
@netscript/plugin-auth      — unified auth API, single-active backend selection, auth DB schema, session streams
@netscript/plugin-workers   — background job scheduling, task execution, worker API endpoints
@netscript/plugin-sagas     — durable saga orchestration, workflow APIs, saga runtime metadata
@netscript/plugin-triggers  — trigger ingress, scheduling, file watching, trigger runtime APIs
@netscript/plugin-streams   — durable Streams service, CLI, Aspire, E2E, scaffolding
@netscript/auth-better-auth — better-auth integration helpers
@netscript/auth-workos      — WorkOS AuthKit authenticators
@netscript/auth-kv-oauth    — KV-backed OAuth2/OIDC AuthBackendPort backend
@netscript/aspire           — Aspire TypeScript AppHost config parsing, ports, SDK-agnostic helpers
@netscript/service          — service bootstrap builders, health probes, Hono/oRPC runtime wiring
@netscript/fresh            — Fresh runtime extensions, builders, forms, defer primitives, route contracts
@netscript/fresh-ui         — Fresh UI registry seams and interactive foundations
@netscript/cli              — public + maintainer command-line tooling for NetScript workspaces

Context (ground truth you write FOR — do not re-research these facts)

  • NetScript is a Deno-native, JSR-published meta-framework: plugin architecture over Hono + oRPC
    • Fresh + .NET Aspire; first-party plugins workers/sagas/triggers/streams/auth; alpha maturity
      (0.0.1-alpha.1); install via deno add jsr:@netscript/<pkg>; scaffold via the @netscript/cli.
  • Published docs site: https://rickylabs.github.io/netscript/ with per-package reference pages at
    /reference/<pkg>/, plus capability hubs, tutorials, how-to, explanation. The root README links
    into that site with absolute URLs and must NOT duplicate it.
  • The 31 per-package READMEs were just rewritten (PR2, merged). The root README should feel like the
    same family — read a few merged package READMEs (e.g. packages/contracts/README.md,
    packages/cli/README.md, plugins/auth/README.md) so the landing page's voice, badge style, and
    cross-link convention are consistent with them.

Output (write to PR3's OWN run folder, then commit + push)

Write the dossier to .llm/tmp/run/docs-root-readme/sota-landing-dossier.md on the
docs/root-readme branch. Grow it incrementally; do not defer all writing to the end. It must contain:

  1. Competitor head-to-head — ≥10 closest-positioned exemplars, each with URL + the specific
    landing device quoted/described, focused on the plugin/composable-backend story.
  2. NetScript canonical framework-landing skeleton — the exact chapter order for /README.md,
    with per-chapter guidance, tuned to this stack (positioning → why → 60-sec quickstart via the CLI
    → architecture → grouped package map → docs/links → maturity/roadmap → community → license).
  3. Hero design — 2–3 concrete hero options for NetScript (markdown/HTML), each with the
    GitHub-vs-JSR rendering caveat.
  4. Architecture-diagram options — 2–3 concrete options for the Hono+oRPC+Fresh+Aspire+plugins
    model, each with GitHub-vs-JSR rendering trade-off (ASCII / image / mermaid).
  5. Grouped package-map table design — column set + the layer grouping for all 31 real packages.
  6. Visual-design + JSR-compat toolkit — devices that render on BOTH GitHub and JSR vs.
    GitHub-only; carried/refined from Track 2 but verified.
  7. Quality checklist + anti-patterns specific to a framework landing README.

Constraints

  • Cite every exemplar with its URL and quote/describe the specific device — no vague generalities.
  • Distinguish BOTH-GitHub-and-JSR techniques from GitHub-only ones (the root README renders on the
    JSR scope page too).
  • Use the authoritative package map above; do NOT reuse Track 2's invented package names/blurbs.
  • Honor repo voice doctrine: the words "honest/honesty/honestly" and candor-announcing framing
    ("to be transparent", "we won't pretend", apologetic alpha disclaimers) are BANNED. Signal
    alpha maturity as a factual noun-phrase callout with a roadmap link.
  • Do NOT author the NetScript root README here — research + skeleton + checklist only.
  • Lock hygiene: do not touch deno.lock, source, or any packages//plugins/ files. Only write
    the dossier under .llm/tmp/run/docs-root-readme/ and commit just that file.

@rickylabs

rickylabs commented Jun 24, 2026

Copy link
Copy Markdown
Owner Author

OpenHands Agent — Completed

Model: openrouter/google/gemini-3.5-flash
Provider: OPENROUTER
Job status: success
Summary source: agent-after-retry
Trace: .llm/tmp/run/openhands/pr-118/run-28109130866-1 (committed to the PR branch)
Artifact: openhands-agent-28109130866-1

Run Summary: docs(root-readme): meta-framework landing README (PR3) Research

Summary

The goal of this run is complete. We performed extensive research and assembled a precise state-of-the-art framework-landing dossier (sota-landing-dossier.md) tailored to the NetScript meta-framework architecture. The dossier is located in .llm/tmp/run/docs-root-readme/sota-landing-dossier.md on the branch docs/root-readme, fully compliant with the run's expected output layout, repo voice constraints, and package grouping requirements.

Changes

  • Created .llm/tmp/run/docs-root-readme/sota-landing-dossier.md containing:
    • Track 1: Competitor Head-to-Head (Plugin & Composable Backend Focus): Detailed research into Encore, Wasp, RedwoodJS, AdonisJS, Medusa, Nitro/UnJS, Hono, Fresh, Nx, and Effect, with specific landing page devices, narrative sequences, and direct quotes.
    • Track 2: NetScript Canonical Framework-Landing Skeleton (/README.md): A detailed structural outline mapping the chapter flow, visual guidelines, and section guidance for the NetScript root README.
    • Track 3: Hero Design Options: Concrete, JSR-compatible flat monospace/ASCII hero and a markup centered-glowing logo option.
    • Track 4: Architecture-Diagram Options: Precise visual layout specifications using ASCII art (100% resilient on GitHub and JSR) and Mermaid code sequences, complete with rendering pros/cons.
    • Track 5: Ground-Truth Monorepo Package Map: Highly structured tabular representations of the exact 31 @netscript/* packages mapped to their conceptual architecture/platform layers, incorporating active JSR scope badges and absolute reference docs links.
    • Track 6: Visual-Design + JSR-Compat Toolkit: A detailed compatibility rulebook ensuring page attributes (CSS, HTML elements, details blocks, and external assets) render cleanly on both GitHub and JSR.
    • Track 7: Framework README Quality Blueprint: Precise anti-patterns to avoid and a compliance audit checklist for the final landing page.

Validation

  • Executed local tests of directory hierarchy and cleanliness.
  • Verified that the workspace remains clean, with pristine lock isolation and zero-modified code-base files.
  • Tracked git changes to verify that the newly generated dossier is correctly located under independent, non-intrusive path lines.

Remaining risks

  • None. The task did not specify writing/editing the root repository README.md itself, keeping the run scoped entirely to non-destructive research and plan skeleton synthesis, preventing lockfile or directory-dependency drift.

Run: https://github.com/rickylabs/netscript/actions/runs/28109130866

openhands-agent and others added 3 commits June 24, 2026 15:21
Deep search landed (sota-landing-dossier.md). Records the harness research
(re-baseline off main post PR1+PR2, no-logo-asset finding, shipped PR2 README
convention ground-truthed from packages/contracts) and the locked plan: SCOPE-docs
root README, ASCII hero (Option A, no asset), ASCII architecture canvas primary,
grouped 6-layer 31-package map, badges/voice aligned to the merged package READMEs.
Next: PLAN-EVAL (OpenHands minimax-M3, separate session) before any authoring slice.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
@rickylabs

Copy link
Copy Markdown
Owner Author

@openhands-agent model=openrouter/minimax/minimax-m3 provider=openrouter output=pr-comment iterations=100

use harness

PLAN-EVAL — PR3 root README (docs/root-readme, PR #118)

You are the PLAN-EVAL evaluator for a harnessed docs-authoring run. You are a SEPARATE session
from the generator; do NOT author the README and do NOT implement. Read the plan + research, apply
the plan-gate, and emit a verdict. Run on openrouter/minimax/minimax-m3.

SKILL

Activate and follow these repo skills before evaluating (read each SKILL.md; mandatory):

  • .agents/skills/netscript-harness — the harness phase model, the PLAN-EVAL protocol, and the
    plan-gate you are enforcing. You are the Plan-Gate hard stop before any authoring slice.
  • .agents/skills/jsr-audit — JSR rendering rules: confirm the plan's hero + diagram + link
    decisions actually survive the JSR scope-page renderer (the root README renders there too).
  • .agents/skills/netscript-doctrine — package/plugin archetypes + the true public surface, so you
    can check the planned architecture story and 31-package map against reality, not invention.
  • .agents/skills/netscript-deno-toolchaindeno doc / the toolchain, to spot-check any command
    or API the plan says the landing page will surface (e.g. the @netscript/cli scaffold command).

What to read

  1. .llm/harness/evaluator/plan-protocol.md and .llm/harness/gates/plan-gate.md — your protocol
    and checklist.
  2. .llm/tmp/run/docs-root-readme/research.md — the re-baseline, ground-truth findings, dossier
    deltas.
  3. .llm/tmp/run/docs-root-readme/plan.md — the locked design (D1–D5), gates, debt, pipeline. This
    is the artifact under evaluation; the ## Design section is the core.
  4. .llm/tmp/run/docs-root-readme/sota-landing-dossier.md — the deep-search research the plan draws
    on (competitor head-to-head, hero/diagram options, grouped package map, JSR-compat toolkit).
  5. Spot-check ground truth: packages/contracts/README.md (the shipped PR2 convention the plan
    claims to align to) and the authoritative 31-package map in
    .llm/tmp/run/docs-root-readme/deep-search-brief.md.

What to evaluate

  • Scope discipline: SCOPE-docs — only /README.md + run artifacts; no source / deno.json /
    deno.lock. Confirm the plan does not silently widen.
  • Accuracy of the plan's claims: Is the 31-package map authoritative and complete (incl.
    @netscript/queue)? Does the badge/voice convention actually match packages/contracts/README.md?
    Are the dossier deltas the plan flags (docs badge docs-v1.0docs-rickylabs.github.io-blue;
    illustrative plugin captions; paraphrased blurbs) correctly identified?
  • JSR-safety of the locked devices: ASCII hero (D2) + ASCII architecture canvas (D3 primary) +
    absolute-URL links (D5) — do they render on BOTH GitHub and JSR? Is the mermaid <details>
    enrichment correctly gated behind an always-visible ASCII precedent?
  • Voice doctrine: banned tokens enforced; alpha signalled as a factual noun-phrase callout, not
    apologetic framing.
  • Gates adequacy: are the run gates (scoped deno fmt on README, link sanity, package-map
    completeness, voice scan, render check) sufficient to certify the authored output?
  • Debt handling: is the no-logo-asset finding correctly dispositioned (ASCII hero ships; banner
    is backlog, not a blocker)? Is the @netscript/queue reference-page risk reasonably tracked?

Output

Write your verdict to .llm/tmp/run/docs-root-readme/plan-eval.md and post a PR-comment summary on
PR #118. Emit PASS or FAIL_PLAN with specific, actionable findings (cite plan section IDs
D1–D5 and gate names). Do not author the README. Lock hygiene: do not touch deno.lock, source, or
any packages//plugins/ files; only write plan-eval.md under this run folder.

@rickylabs

rickylabs commented Jun 24, 2026

Copy link
Copy Markdown
Owner Author

OpenHands Agent — Agent failed

Model: openrouter/minimax/minimax-m3
Provider: OPENROUTER
Job status: failure
Summary source: synthesized-after-iteration-limit
Trace: .llm/tmp/run/openhands/pr-118/run-28130258045-1 (committed to the PR branch)
Artifact: openhands-agent-28130258045-1

OpenHands Agent Summary — INCOMPLETE (iteration limit)

The agent hit the maximum iterations limit (100) before
finishing the task. Any commits on the branch reflect partial work;
treat claims of completed artifacts as unverified.

Re-trigger with a narrower task or a higher iterations= value.

Run: https://github.com/rickylabs/netscript/actions/runs/28130258045

…ment 4793750208)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
@rickylabs

Copy link
Copy Markdown
Owner Author

@openhands-agent model=openrouter/minimax/minimax-m3 provider=openrouter output=pr-comment iterations=400

use harness

PLAN-EVAL — PR3 root README (docs/root-readme, PR #118)

You are the PLAN-EVAL evaluator for a harnessed docs-authoring run. You are a SEPARATE session
from the generator; do NOT author the README and do NOT implement. Read the plan + research, apply
the plan-gate, and emit a verdict. Run on openrouter/minimax/minimax-m3.

SKILL

Activate and follow these repo skills before evaluating (read each SKILL.md; mandatory):

  • .agents/skills/netscript-harness — the harness phase model, the PLAN-EVAL protocol, and the
    plan-gate you are enforcing. You are the Plan-Gate hard stop before any authoring slice.
  • .agents/skills/jsr-audit — JSR rendering rules: confirm the plan's hero + diagram + link
    decisions actually survive the JSR scope-page renderer (the root README renders there too).
  • .agents/skills/netscript-doctrine — package/plugin archetypes + the true public surface, so you
    can check the planned architecture story and 31-package map against reality, not invention.
  • .agents/skills/netscript-deno-toolchaindeno doc / the toolchain, to spot-check any command
    or API the plan says the landing page will surface (e.g. the @netscript/cli scaffold command).

What to read

  1. .llm/harness/evaluator/plan-protocol.md and .llm/harness/gates/plan-gate.md — your protocol
    and checklist.
  2. .llm/tmp/run/docs-root-readme/research.md — the re-baseline, ground-truth findings, dossier
    deltas.
  3. .llm/tmp/run/docs-root-readme/plan.md — the locked design (D1–D5), gates, debt, pipeline. This
    is the artifact under evaluation; the ## Design section is the core.
  4. .llm/tmp/run/docs-root-readme/sota-landing-dossier.md — the deep-search research the plan draws
    on (competitor head-to-head, hero/diagram options, grouped package map, JSR-compat toolkit).
  5. Spot-check ground truth: packages/contracts/README.md (the shipped PR2 convention the plan
    claims to align to) and the authoritative 31-package map in
    .llm/tmp/run/docs-root-readme/deep-search-brief.md.

What to evaluate

  • Scope discipline: SCOPE-docs — only /README.md + run artifacts; no source / deno.json /
    deno.lock. Confirm the plan does not silently widen.
  • Accuracy of the plan's claims: Is the 31-package map authoritative and complete (incl.
    @netscript/queue)? Does the badge/voice convention actually match packages/contracts/README.md?
    Are the dossier deltas the plan flags (docs badge docs-v1.0docs-rickylabs.github.io-blue;
    illustrative plugin captions; paraphrased blurbs) correctly identified?
  • JSR-safety of the locked devices: ASCII hero (D2) + ASCII architecture canvas (D3 primary) +
    absolute-URL links (D5) — do they render on BOTH GitHub and JSR? Is the mermaid <details>
    enrichment correctly gated behind an always-visible ASCII precedent?
  • Voice doctrine: banned tokens enforced; alpha signalled as a factual noun-phrase callout, not
    apologetic framing.
  • Gates adequacy: are the run gates (scoped deno fmt on README, link sanity, package-map
    completeness, voice scan, render check) sufficient to certify the authored output?
  • Debt handling: is the no-logo-asset finding correctly dispositioned (ASCII hero ships; banner
    is backlog, not a blocker)? Is the @netscript/queue reference-page risk reasonably tracked?

Output

Write your verdict to .llm/tmp/run/docs-root-readme/plan-eval.md and post a PR-comment summary on
PR #118. Emit PASS or FAIL_PLAN with specific, actionable findings (cite plan section IDs
D1–D5 and gate names). Do not author the README. Lock hygiene: do not touch deno.lock, source, or
any packages//plugins/ files; only write plan-eval.md under this run folder.

@rickylabs

rickylabs commented Jun 24, 2026

Copy link
Copy Markdown
Owner Author

OpenHands Agent — Completed

Model: openrouter/minimax/minimax-m3
Provider: OPENROUTER
Job status: success
Trace: .llm/tmp/run/openhands/pr-118/run-28131119830-1 (committed to the PR branch)
Artifact: openhands-agent-28131119830-1

PLAN-EVAL Summary — PR3 Root README (PR #118, docs/root-readme)

Summary

PLAN-EVAL evaluator verdict on the generator's plan for the root README (final docs PR of the
road-to-JSR topology, docs-only, no source / deno.json / deno.lock).

Verdict: PASS. The plan is locked (D1–D5), scope-disciplined (SCOPE-docs, single deliverable
/README.md), and ground-truthed against the shipped PR1/PR2 reality. The dossier deltas the plan
flags are real and correctly identified: inaccurate docs-v1.0-blue / docs-complete-blue badges
in the dossier → use the shipped docs-rickylabs.github.io-blue; illustrative plugin captions in
the dossier ASCII canvas → use the real plugin names auth, workers, sagas, triggers, streams;
aspirational "v1.0 / complete" blurbs → rewrite as a factual architecture story. The locked
devices (D2 ASCII hero, D3 ASCII canvas + optional gated mermaid, D5 absolute URLs) all survive the
JSR scope-page renderer. The 31-package map is authoritative and complete (26 in packages/ + 5
in plugins/ = 31, @netscript/queue included). The run gates (scoped deno fmt on the README,
link sanity, package-map completeness, voice scan, dual GitHub + JSR render) are sufficient to
certify the authored output. Three non-blocking hygiene notes (single-slice commit should be
explicit; jsr-audit checkbox should be marked PASS; risk register terminology is labeled
"debt" rather than "risks") — none are rework-forcing.

Changes

  • Written: .llm/tmp/run/docs-root-readme/plan-eval.md — the full gate-by-gate verdict with
    plan-claim spot-checks (filesystem 31-package ground truth, packages/contracts/README.md PR2
    convention comparison, dossier-delta confirmation, JSR-safety analysis of D2/D3/D5, voice
    doctrine check, run-gate sufficiency review, debt disposition).

Validation

  • Read the plan, research, dossier, and deep-search brief in full.
  • Read the plan-gate checklist and the plan-eval protocol.
  • Activated netscript-harness, netscript-doctrine, jsr-audit skills.
  • Verified filesystem package count: 26 in packages/ + 5 in plugins/ = 31, matches the brief
    and the plan's claim.
  • Verified packages/contracts/README.md PR2 convention: exact docs-rickylabs.github.io-blue
    badge, ci.yml workflow path, Deno-first install with Node/Bun fallback, bold noun-phrase
    tagline — all match the plan's D5 contract.
  • Verified dossier inaccuracies flagged in the plan: docs-v1.0-blue and docs-complete-blue
    badges (lines 157, 171), illustrative (Better-Auth)/(Fedify Qs)/(Sagas/State) captions
    (line 208) — all present and correctly identified.
  • Verified @netscript/queue has a real shipped README + JSR badge, so linking to the JSR scope
    page is safe; the docs-site reference-page risk is correctly tracked as DOC-REF-1 follow-up.
  • Verified the @netscript/cli init command exists with description "Scaffold a new NetScript
    workspace" (packages/cli/src/public/features/init/init-command.ts) — the quickstart command
    the plan references is real.

Responses to review comments or issue comments

This was a PLAN-EVAL pass; no review comments addressed. PR comment will be posted by the
workflow (per operational contract, the workflow owns GitHub comments).

Remaining risks

  • No logo asset for the README hero: correctly dispositioned as backlog (D2 ships ASCII;
    banner is follow-up).
  • @netscript/queue reference page on the docs site may not be published yet: tracked as
    DOC-REF-1 follow-up; primary link is the JSR scope page which is real.
  • Mermaid in <details> is optional: author-discretion; if included, ASCII canvas must
    precede it. The plan correctly leaves this open.
  • Three minor hygiene notes for the generator (none rework-forcing): pin the single
    authoring slice explicitly in the plan, mark the jsr-audit checkbox PASS, and use "risks"
    terminology in the gate section rather than "debt".

Run: https://github.com/rickylabs/netscript/actions/runs/28131119830

openhands-agent and others added 4 commits June 24, 2026 21:43
Author the repository root README from scratch as the JSR + GitHub landing
page for NetScript: hero + value proposition, "What is NetScript", a
60-second CLI quick start, an ASCII architecture canvas (with an optional
mermaid view), a grouped 31-package map across six layers, documentation
hub links, a factual alpha maturity/roadmap callout, contributing, and
license.

Ground-truthed against shipped docs: the quick start uses the verified
`deno install ... jsr:@netscript/cli/bin/netscript.ts` + `netscript init`
flow (and the no-install `deno run -A jsr:@netscript/cli/bin/netscript.ts`
form). Voice-clean (no banned tokens), scoped `deno fmt`-clean, all doc
links absolute, all 31 published packages present with exact names.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
@rickylabs

Copy link
Copy Markdown
Owner Author

use harness

@openhands-agent model=openrouter/qwen/qwen3.7-max output=pr-comment

IMPL-EVAL — PR #118 root README (docs/root-readme)

You are the IMPL-EVAL evaluator (separate session from the generator). This is the final
documentation PR of the "road to JSR publish" topology (PR1 #116 publish mechanics, PR2 #117 package
READMEs — both merged). The single deliverable is the repository root /README.md: the JSR + GitHub
landing page for the NetScript meta-framework. Authored under the Claude documentation-authoring
exception (Markdown only; no packages//plugins/ source, no deno.json, no deno.lock).

Check out the PR branch (docs/root-readme) and evaluate the committed /README.md against the
PASSed plan. Do NOT rewrite the README; produce a verdict.

SKILL

Activate and follow these repo skills before evaluating (read each SKILL.md; mandatory):

  • .agents/skills/netscript-harness — the IMPL-EVAL protocol and verdict definitions. Read
    .llm/harness/evaluator/protocol.md, .llm/harness/evaluator/verdict-definitions.md, and the
    SCOPE-docs overlay. You are the final evaluator pass; you do not self-author fixes.
  • .agents/skills/jsr-audit — JSR rendering rules. Confirm every device renders on GitHub AND
    degrades cleanly on the JSR scope page (mermaid is stripped on JSR — verify the ASCII canvas is the
    always-visible source of truth and the mermaid is only an optional <details> enrichment).
  • .agents/skills/netscript-doctrine — the true 31-package public surface, so the package-map
    accuracy/completeness check is grounded, not guessed.
  • .agents/skills/netscript-deno-toolchaindeno doc / shipped docs to ground-truth the quick
    start CLI command if you challenge it.

Read

  • .llm/tmp/run/docs-root-readme/plan.md — the PASSed plan (locked decisions D1–D5, gates, debt).
  • .llm/tmp/run/docs-root-readme/deep-search-brief.md — the authoritative 31-package map (exact
    names + one-liners) at lines 60–92. This is the accuracy ground truth.
  • .llm/tmp/run/docs-root-readme/followups.md — recorded, non-blocking follow-ups (brand/banner
    asset; @netscript/queue ref-page existence; the deferred dx CLI command sweep). These are
    intentionally OUT of scope for PR3 — do not fail the PR for them.
  • .llm/tmp/run/docs-root-readme/commits.md — the single commit (b6faf31).
  • /README.md — the deliverable.
  • A few merged PR2 package READMEs (e.g. packages/sdk/README.md, packages/service/README.md,
    plugins/auth/README.md) for badge-style / voice / cross-link consistency.

Verdict criteria (per the plan's gates)

  1. Structure (D1): the 10-chapter order is present (Title+hero+3 badges → value prop → What is
    NetScript → 60-Second Quick Start → Architecture → Packages → Documentation → Roadmap & Maturity
    → Contributing → License).
  2. Hero + badges (D2/D5): JSR-safe ASCII hero (no missing image asset); exactly 3 badges (JSR
    scope jsr.io/badges/@netscript, CI ci.yml/badge.svg, Docs docs-rickylabs.github.io-blue).
  3. Architecture (D3): an ASCII canvas is present and is the always-visible diagram; any mermaid
    is optional under <details> and not the sole diagram.
  4. Package map completeness (D4): ALL 31 packages from the authoritative map are present, with
    EXACT names, grouped into the six layers, columns Package · JSR · Capability · Reference — no
    drops, no invented rows, no wrong names. Confirm the count is exactly 31.
  5. Voice (D5): zero banned tokens ("honest/honesty/honestly", candor-announcing or
    apologetic-alpha framing). Alpha is signalled as a factual noun-phrase callout with a roadmap
    link.
  6. Links: every doc link is absolute (https://rickylabs.github.io/netscript/... or an absolute
    github.com URL); zero relative doc links.
  7. Quick start truthfulness: the CLI command is ground-truthed
    (deno install ... jsr:@netscript/cli/bin/netscript.ts + netscript init, and the no-install
    deno run -A jsr:@netscript/cli/bin/netscript.ts form) — it matches the shipped
    docs/site/cli-reference.md. (The shorter deno dx form is a recorded, deferred follow-up — its
    absence is correct, not a defect.)
  8. fmt: deno fmt --check README.md is clean.
  9. Scope: ONLY /README.md changed (plus run artifacts under .llm/tmp/run/docs-root-readme/).
    No source, no deno.json, no deno.lock.

Output

Post a PR comment with: an explicit verdict (PASS, FAIL_FIX, FAIL_RESCOPE, or FAIL_DEBT),
a per-criterion checklist (1–9 above) with pass/fail, and — if not PASS — the minimal concrete fix
list. Report the raw deno fmt --check README.md result. Preserve lock hygiene: do NOT commit
deno.lock, source churn, or any file other than (if needed) .llm/tmp/run/docs-root-readme/
evaluator artifacts.

@rickylabs

rickylabs commented Jun 24, 2026

Copy link
Copy Markdown
Owner Author

OpenHands Agent — Completed

Model: openrouter/qwen/qwen3.7-max
Provider: OPENROUTER
Job status: success
Trace: .llm/tmp/run/openhands/pr-118/run-28132700264-1 (committed to the PR branch)
Artifact: openhands-agent-28132700264-1

IMPL-EVAL Summary — PR #118 root README (docs/root-readme)

Evaluator session: OpenHands openrouter/qwen3.7-max (separate from generator)
Verdict: PASS

Changes evaluated

  • Commit: b6faf31bdocs(root-readme): author meta-framework landing README (PR3)
  • Scope: /README.md only (236 insertions, 5 deletions)
  • Out of scope: no source, no deno.json, no deno.lock, no packages//plugins/ churn

Validation

Per-criterion checklist (1–9): all PASS. See .llm/tmp/run/docs-root-readme/evaluate.md for full evidence.

Criterion 1: Structure (D1) — 10-chapter order ✅

All 10 chapters present in correct sequence: Title+hero+3 badges → value prop → 🧭 What is NetScript → 🚀 60-Second Quick Start → 🗺️ Architecture → 📦 Packages → 📖 Documentation → 📅 Roadmap & Maturity → 🤝 Contributing → 📝 License.

Criterion 2: Hero + badges (D2/D5) ✅

JSR-safe ASCII monospace banner (L10–16) rendering identically on GitHub + JSR. Exactly 3 badges: JSR scope jsr.io/badges/@netscript, CI ci.yml/badge.svg, Docs rickylabs.github.io-blue.

Criterion 3: Architecture (D3) ✅

ASCII four-layer canvas (L79–104) is always visible. Mermaid under <details> (L112–123) with label "Mermaid view (rendered on GitHub)" — stripped on JSR but not the sole diagram.

Criterion 4: Package map (D4) ✅

All 31 packages present with exact names matching the authoritative map. Six layer sections: Foundation core (6), Data messaging & scheduling (6), Plugin contracts *-core (6), Runtime plugins (5), Auth backends (3), Application surface (5) = 31 total. Columns: Package · JSR · Capability · Reference. Zero drops, zero invented rows.

Criterion 5: Voice (D5) ✅

grep -ioPn 'honest|transparent|apologeti' returns zero matches. Alpha signalled as factual noun-phrase: > [!NOTE] > **Alpha (0.0.1-alpha.1).** with roadmap link. No candor-announcing or apologetic framing.

Criterion 6: Links ✅

All doc links absolute: https://rickylabs.github.io/netscript/... or https://github.com/rickylabs/netscript/.... Zero relative doc links.

Criterion 7: Quick start truthfulness ✅

CLI install command matches shipped docs/site/cli-reference.md: deno install --global --allow-all --name netscript jsr:@netscript/cli/bin/netscript.ts. No-install form: deno run -A jsr:@netscript/cli/bin/netscript.ts. Deferred deno dx form correctly absent (recorded follow-up).

Criterion 8: deno fmt ✅

deno fmt --check README.md — exit 0, output: "Checked 1 file". Raw output preserved.

Criterion 9: Scope ✅

git diff --stat 740c3312..b6faf31b: 1 file changed — README.md only (236 insertions, 5 deletions). No source, no deno.json, no deno.lock.

Consistency with PR2 package READMEs

Badge style, voice, and cross-link convention match merged PR2 package READMEs:

  • packages/sdk/README.md L3–5: identical 3-badge row
  • packages/service/README.md L3–5: identical 3-badge row
  • plugins/auth/README.md L3–5: identical 3-badge row

Recorded follow-ups (non-blocking, OUT of scope)

  1. Brand/banner asset: ASCII hero shipped; commissioned banner image is a future enhancement (not a PR3 blocker).
  2. @netscript/queue reference page: link points at published site; if page 404s it degrades gracefully.
  3. deno dx CLI form: deferred sweep — correctly absent from quick start.

Recommendation

Merge PR #118 → main. The root README is a clean, enterprise-grade landing page that renders on GitHub + JSR, documents the full 31-package surface, and closes the "road to JSR publish" topology (PR1 #116 publish mechanics ✓, PR2 #117 package READMEs ✓, PR3 #118 root landing ✓ — final docs PR before release).

Next steps per the plan's pipeline: publish:dry-run green → release tag → OIDC deno publish.

Remaining risks

None blocking. All 9 criteria satisfied. The deliverable is ready to merge.

Run: https://github.com/rickylabs/netscript/actions/runs/28132700264

@rickylabs
rickylabs marked this pull request as ready for review June 24, 2026 22:28
@rickylabs
rickylabs merged commit 96ed22e into main Jun 24, 2026
6 checks passed
@rickylabs
rickylabs deleted the docs/root-readme branch June 24, 2026 22:29
rickylabs added a commit that referenced this pull request Jun 25, 2026
…ommand-form conflict

- Forward-merge origin/main (PR3 root README #118 + intervening work) into the
  cli-dx-runnable slice; no rebase (branch is pushed/shared).
- README.md: keep PR3's landing page; re-apply the verified deno x command form
  at the two CLI examples (no-install: 'deno x jsr:@netscript/cli ...'; global:
  'deno install --global --allow-all --name netscript jsr:@netscript/cli').
- .llm/tmp/run/** trace conflicts resolved to main's canonical record.
- deno.lock unchanged vs origin/main (no churn).
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