docs(readme-revamp): package + framework README revamp (PR2)#117
Conversation
…anding READMEs Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018fq9V7ujx7e1rWXi57qkPG
|
@openhands-agent model=openrouter/google/gemini-3.5-flash provider=openrouter output=pr-comment iterations=400 use harness — deep-search research run (NOT implementation, NOT an evaluator gate). Produce a state-of-the-art README dossier that will ground a from-scratch rewrite of every NetScript package README and the root framework README. You are on branch Write your findings to Summary of what to deliver (full detail in the brief):
Hard constraints:
Deliver a short index of the dossier in this PR comment thread when done. |
OpenHands Agent — CompletedModel: openrouter/google/gemini-3.5-flash OpenHands Agent SummarySynthesized by agent_runner: the agent completed without writing the Final agent messagecall:default_api:file_editor{command:str_replace,new_str:# State-of-the-Art README Dossier: NetScript Revamp Blueprints This dossier contains the research findings, patterns, canonical skeletons, quality checklists, and visual design toolkits for the complete revamp of the NetScript repository READMEs. It is organized into two distinct research tracks:
NetScript Core Ground Truth & Voice DoctrineTo ground all authoring and design decisions, the following facts and constraints are absolute:
Track 1: Best-in-Class Package / Library READMEs (Serves PR2)This track details how individual packages or libraries construct their README files to serve as high-signal, self-contained guides that immediately onboard users and direct them to central documentation websites. 1. Exemplar Analysis (11 Best-in-Class Libraries)To establish standard expectations, we analyzed 11 notable packages across JS/TS, Deno/JSR, and rust-adjacent systems. 1. Hono (
|
| Rank | Pattern Name / Visual Device | URL / Exemplar Evidence | Specific Implementation / Quote Context |
|---|---|---|---|
| 1 | Direct Target Runtime Snippet | honojs/hono |
"import { Hono } from 'hono'" ... "app.get('/', ...)" - A simple, 10-line runnable snippet showing immediate utility. |
| 2 | Unified Fast Links Bar | drizzle-team/drizzle-orm |
Centered text grid: [Website](url) • [Documentation](url) • [Twitter](url) • [Discord](url) - Keeps headers extremely high-density. |
| 3 | Estimated Reading Time Tags | prisma/prisma |
Links styled as: [Quickstart (5 min)](url). Immediately manages user attention and signals low friction. |
| 4 | Standard Tagline Precision | colinhacks/zod |
Avoids vague phrases. Declares exact role: "TypeScript-first schema declaration and validation library." |
| 5 | Light/Dark Contrast Suffixing | biomejs/biome |
Centered <picture> elements swapping SVGs depending on OS preference. Prevents white-box background clipping. |
| 6 | Auto-Generated API Block | unjs/ufo |
Comments <!-- automd:jsdocs --> inject doc blocks matching export comments. Ensures zero drift with actual source code. |
3. Canonical Package README Skeleton (@netscript/<pkg>)
Copy-pasteable blueprint for all 31 individual NetScript packages. It ensures seamless JSR-to-GitHub formatting compatibility.
# @netscript/<package-name>
<div align="center">
<p align="center">
<a href="https://rickylabs.github.io/netscript/reference/<package-name>/">Documentation</a> •
<a href="https://rickylabs.github.io/netscript/">Framework Hub</a> •
<a href="https://github.com/rickylabs/netscript/issues">Report Issue</a>
</p>
[](https://jsr.io/@netscript/<package-name>)
[](https://github.com/rickylabs/netscript/blob/main/LICENSE)
</div>
<br />
**@netscript/<package-name>** is a JSR-published, Deno-native package providing [one-sentence core technical capability, e.g., typesafe streams] for the NetScript meta-framework.
> [!NOTE]
> This package is currently in **Alpha** (`0.0.1-alpha.1`). It is fully functional but subject to API stabilization. High-signal feedback and bug reports are welcome.
## Technical Capability Highlights
* **Deno-First Integrity:** Zero-overhead natively on Deno 2.8, utilizing native Web Platform APIs.
* **Type-Safe Binding:** Integrates deeply with Hono + oRPC pipelines for contract-first end-to-end type safety.
* **Plugin Archetype:** Exposes a Standard NetScript plugin interface compatible with central CLI scaffolds.
## Installation
Install via JSR into your Deno project:
```bash
deno add jsr:@netscript/<package-name>(For Node, Bun, or other environments, standard transpiled installations are handled via npx jsr add @netscript/<package-name>)
Quick Start
// Import the native contract
import { createPlugin } from "jsr:@netscript/<package-name>";
// Initialize with framework instance
const myPlugin = createPlugin({
// Exact configurations
});
export default myPlugin;Deep-Dive Documentation
This package is part of the NetScript Meta-Framework. To prevent drift, complete references and walkthroughs are hosted on the primary docs site:
License
---
### 4. Package Quality Checklist
Before finalizing any package README, it must satisfy this validation table:
* [ ] **Correct JSR Scope Mapping:** The name must be styled as `@netscript/<pkg>` and the install command mapped as `deno add jsr:@netscript/<pkg>`.
* [ ] **Zero Relative Links:** Any hyperlink to documentation or guide files **must use absolute URLs** starting with `https://rickylabs.github.io/netscript/` or `https://github.com/rickylabs/netscript/blob/...`. *Reason: Relative paths break completely when viewed/rendered on JSR.*
* [ ] **Runnable Code Verification:** Every typescript snippet inside the README must type-check and match actual package exports. No mock imports or invented variables.
* [ ] **Alpha Status Suffix:** Must prominently display the exact alpha marker (`0.0.1-alpha.1`) without apologetic vocabulary.
* [ ] **Voice Enforcement:** Check full text to ensure no instances of "honestly", "honesty", "honests", or candor-announcing frames exist.
---
### 5. Package-Level Anti-Patterns
1. **The Relative Link Trap:** Using `./docs/getting-started.md` inside a package README. JSR package registry renders the readme on `jsr.io`, causing relative links to return 404.
2. **Badge Soup:** Crowding the top of a package readme with 15 standard badges (downloads, dependency counts, system sizes, lines of code). It creates optical noise and delays finding the installation line.
3. **Invented SDK Snippets:** Writing pseudo-code examples that look clean but do not compile against the actual framework runtime.
4. **"Honesty" Deflection:** Using phrasing like *"Honestly, this package is still early so please expect bugs"*. It violates the authoritative professional voice. Use: *"This package is in Alpha (0.0.1-alpha.1) with stabilizing API schemas"* instead.
---
## Track 2: Monorepo / Framework Landing READMEs (Serves PR3)
The root workspace README is the front door of NetScript. The architectural design bar here is exceptionally high—demanding enterprise-grade reliability, visual coherence, and immediate engineering appeal.
### 1. Exemplar Analysis (11 Monorepos & Frameworks)
We analyzed 11 framework directories to determine how they manage root positioning and package orchestration.
#### 1. Nuxt (`nuxt/nuxt`)
* **URL:** [https://github.com/nuxt/nuxt/blob/main/README.md](https://github.com/nuxt/nuxt/blob/main/README.md)
* **Hero Treatment:** High-resolution svg banner containing standard spacing logo link (`<a href="https://nuxt.com"><img width="830" src="./.github/assets/banner.svg" ...></a>`).
* **Visual Standout Devices:** Wide badge row, a comprehensive, bulleted features list highlighting compiler strategies (edge-side rendering, hybrid pipelines), and centered layout points.
* **Chapter Structure:** Title banner -> Versatile badge row -> Pitch statement -> Features list -> Quick Start section -> Module support grid -> Contributing.
* **Monorepo Package Map:** Nuxt delegates sub-package mappings to their website marketplace; however, root configurations reference contributing layers clearly.
* **Truthful Alpha/Maturity Signaling:** Explicitly emphasizes production-readiness by linking to enterprise users and security scorecards.
#### 2. Astro (`withastro/astro`)
* **URL:** [https://github.com/withastro/astro/blob/main/README.md](https://github.com/withastro/astro/blob/main/README.md)
* **Hero Treatment:** Elegant, full-width custom graphic containing the slogan *"Build the web you want"*. It is placed as the first line of the document.
* **Visual Standout Devices:** Centered logo blocks, clean badge rows, and styled horizontal rulers creating structured content regions.
* **Chapter Structure:** Graphic banner -> Centered quick intro -> Badges -> Primary Install command -> Getting Started guide portals -> Community lists.
* **GitHub vs. JSR Rendering:** Uses simple markdown rendering combined with isolated blockquotes to format alerts cleanly.
#### 3. Payload CMS (`payloadcms/payload`)
* **URL:** [https://github.com/payloadcms/payload/blob/main/README.md](https://github.com/payloadcms/payload/blob/main/README.md)
* **Hero Treatment:** Full-width high-quality product image showcasing the administrative panel interface in real use.
* **Visual Standout Devices:** Clean horizontal rules separating bolded portal navigation links (`Explore the Docs • Community Help • Roadmap`).
* **Chapter Structure:** Visual graphic -> Badges -> Ruler-bounded Quicklinks -> Spliced blockquote notes -> Key value list -> Feature overview.
* **Monorepo Package Map:** Uses a clean, structural outline pointing to individual plugin packages supporting Next.js integrations.
#### 4. Next.js (`vercel/next.js`)
* **URL:** [https://github.com/vercel/next.js/blob/canary/README.md](https://github.com/vercel/next.js/blob/canary/README.md)
* **Hero Treatment:** Centered title followed by structured package-manager command blocks.
* **Visual Standout Devices:** Clean ASCII block highlights, standardized badge sizing, and direct redirection hyperlinks.
* **Chapter Structure:** Short intro -> Quick Start shell templates -> Comprehensive Features map -> Support and License clauses.
#### 5. Encore (`encoredev/encore`)
* **URL:** [https://github.com/encoredev/encore/blob/main/README.md](https://github.com/encoredev/encore/blob/main/README.md)
* **Hero Treatment:** Full centered terminal image combined with a short tagline describing the platform as an "Event-Driven Backend Engine".
* **Visual Standout Devices:** Embedded high-fidelity architecture diagrams visually breaking down how Encore generates APIs and database models.
* **Chapter Structure:** Bold logo banner -> Interactive overview -> Fast Features grid -> Architectural setup -> Local deployment rules.
#### 6. Remix (`remix-run/remix`)
* **URL:** [https://github.com/remix-run/remix/blob/main/README.md](https://github.com/remix-run/remix/blob/main/README.md)
* **Hero Treatment:** Styled ASCII design header pointing directly to interactive server commands.
* **Visual Standout Devices:** Spliced lists representing nested routing concepts and runtime edge capabilities.
#### 7. NestJS (`nestjs/nest`)
* **URL:** [https://github.com/nestjs/nest/blob/master/README.md](https://github.com/nestjs/nest/blob/master/README.md)
* **Hero Treatment:** Bright red custom NestJS cat logo centered elegantly on white canvas blocks.
* **Visual Standout Devices:** Symmetrical badge layout, bold social buttons, and explicit multi-sponsor profile icons grid.
#### 8. Medusa (`medusajs/medusa`)
* **URL:** [https://github.com/medusajs/medusa/blob/master/README.md](https://github.com/medusajs/medusa/blob/master/README.md)
* **Hero Treatment:** High-density purple cover graphic reflecting transactional systems and backend capabilities.
* **Visual Standout Devices:** Tables comparing standard custom API structures, coupled with icons guiding users to database setup.
#### 9. SvelteKit (`sveltejs/kit` under `/packages/kit`)
* **URL:** [https://github.com/sveltejs/kit/blob/main/packages/kit/README.md](https://github.com/sveltejs/kit/blob/main/packages/kit/README.md)
* **Hero Treatment:** Minimal orange wordmark paired with clear build statements.
* **Visual Standout Devices:** Compact lists containing package-setup details.
#### 10. Bun (`oven-sh/bun`)
* **URL:** [https://github.com/oven-sh/bun/blob/main/README.md](https://github.com/oven-sh/bun/blob/main/README.md)
* **Hero Treatment:** Centered "bun sticker" logo alongside immediate shell install commands.
* **Visual Standout Devices:** Visual terminal charts proving execution performance margins vs. Node.js.
#### 11. Supabase (`supabase/supabase`)
* **URL:** [https://github.com/supabase/supabase/blob/master/README.md](https://github.com/supabase/supabase/blob/master/README.md)
* **Hero Treatment:** Full high-contrast dark green horizontal cover showing database and auth configurations.
* **Visual Standout Devices:** Complete multi-language client library grid tables matching feature targets.
---
### 2. Ranked Visual & Structural Patterns
These are the 6 standout global visual patterns for monorepos, graded for framework-level impact:
[Pattern 1: Visual Theme Switching Banners (Astro / Payload)]
├── Rendered via
[Pattern 2: The Monorepo Packages Matrix (Supabase / Nuxt)]
├── Styled HTML table showing individual plugins + JSR status
└── Instantly answers: "What packages exist in this repo?"
[Pattern 3: Centered Core Quick-Links (Drizzle / NextJS)]
├── One-line, badge-less inline links with centered markup
└── Minimizes visual height and gets user to docs fast
1. **Theme-Aware Banners:** Custom `<picture>` tags changing SVG graphics depending on light/dark mode (e.g. `biomejs/biome`, `better-auth/better-auth`).
2. **Package Matrix Table:** A structured, multi-column grid capturing every package, its description, JSR link, and current directory path (e.g., `supabase/supabase`).
3. **Interactive Autocomplete Demos:** Short `.gif` loops showing exact type-safety responses during backend typing (e.g., `trpc/trpc`). This is preferred over long textual explanations.
4. **Architectural Flow Diagrams:** Styled SVG block lines mapping runtime relationships (e.g., `encoredev/encore`).
5. **Multi-Sponsor Grid Profile Frames:** Renders support grids visually using standardized GitHub avatar grids (e.g., `nestjs/nest`).
---
### 3. Canonical Framework Landing README Skeleton
This is the standard architectural blueprint for the **NetScript Framework Workspace Root README**.
```markdown
<div align="center">
<picture>
<source srcset="https://raw.githubusercontent.com/rickylabs/netscript/main/.github/assets/logo-dark.png" media="(prefers-color-scheme: dark)"/>
<source srcset="https://raw.githubusercontent.com/rickylabs/netscript/main/.github/assets/logo-light.png" media="(prefers-color-scheme: light)"/>
<img src="https://raw.githubusercontent.com/rickylabs/netscript/main/.github/assets/logo-light.png" alt="NetScript Logo" width="600"/>
</picture>
<p align="center">
<strong>Deno-Native Meta-Framework for Built-to-Scale Web Architectures</strong>
</p>
<p align="center">
<a href="https://rickylabs.github.io/netscript/">Documentation Hub</a> •
<a href="#packages-map">Ecosystem Packages</a> •
<a href="https://rickylabs.github.io/netscript/reference/">API Reference</a> •
<a href="https://github.com/rickylabs/netscript/discussions">Community Discussion</a>
</p>
<p align="center">
<a href="https://github.com/rickylabs/netscript/actions"><img src="https://img.shields.io/github/actions/workflow/status/rickylabs/netscript/ci.yml" alt="Build Status" /></a>
<a href="https://jsr.io/@netscript"><img src="https://img.shields.io/badge/JSR-@netscript-black" alt="JSR Org" /></a>
<a href="https://github.com/rickylabs/netscript/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue" alt="License" /></a>
</p>
</div>
<hr />
## What is NetScript?
NetScript is a **Deno-native meta-framework** that orchestrates a streamlined plugin architecture on top of **Hono, oRPC, Fresh, and .NET Aspire**. It enables developers to construct extremely fast, distributed, and type-safe systems with zero configuration drag.
> [!IMPORTANT]
> NetScript is currently in **Alpha** (`0.0.1-alpha.1`). It is undergoing active API refinement. We welcome early adopters, builders, and feedback to help stabilize the stable release line!
### Outstanding Capabilities
* 🦕 **Deno-First Foundations:** Native compatibility with Deno 2.8 and standard JSR publication pipelines.
* 🛡️ **End-to-End Type Safety:** Automatic schema propagation across Hono and oRPC connections.
* ⚙️ ** Aspire Orchestration:** Out-of-the-box local developer orchestrating via Microsoft .NET Aspire integration.
---
## Workspace Packages Map <a id="packages-map"></a>
NetScript is developed as a modular monorepo containing specialized packages and plugins:
| Package Name | JSR Registry | Core Purpose | Directory Path |
| :--- | :--- | :--- | :--- |
| **`@netscript/core`** | [](https://jsr.io/@netscript/core) | Framework engine & plugin lifecycle orchestrator | [`/packages/core`](./packages/core) |
| **`@netscript/workers`** | [](https://jsr.io/@netscript/workers) | Background processing and parallel worker threads | [`/plugins/workers`](./plugins/workers) |
| **`@netscript/sagas`** | [](https://jsr.io/@netscript/sagas) | Eventual-consistency saga orchestrations | [`/plugins/sagas`](./plugins/sagas) |
| **`@netscript/triggers`** | [](https://jsr.io/@netscript/triggers) | Multi-protocol trigger routing systems | [`/plugins/triggers`](./plugins/triggers) |
| **`@netscript/streams`** | [](https://jsr.io/@netscript/streams) | Fully-typed real-time streaming operations | [`/plugins/streams`](./plugins/streams) |
| **`@netscript/auth`**| [](https://jsr.io/@netscript/auth) | Identity binding and token authorization | [`/plugins/auth`](./plugins/auth) |
---
## Quick Start Scaffold
You can spin up a fully configured NetScript application using our official template scaffold:
```bash
deno run -A jsr:@netscript/cli init my-app
Then launch the development orchestrator:
cd my-app
deno task devThis starts the Hono router and automatically hooks into the local .NET Aspire metrics dashboard.
Contributing & Development
We appreciate contributions to our core framework and plugins. Please see CONTRIBUTING.md to understand local testing harnesses and development pipelines.
Active Gate Validations
Validate your local changes before submitting a PR:
deno task check
deno task testLicense
Licensed under the MIT License. Copyright © 2025 RickyLabs.
### 3.1. Hero Pitch Options (Selectable Alternatives)
To meet the PR3 authoring needs, here are three distinct hero option taglines for our workspace:
* **Option A (Architectural Focus):** *"The Enterprise distributed-backend meta-framework for Deno 2.8. Fully typesafe workers, streams, trigger-routings, and sagas, orchestrated under .NET Aspire."*
* **Option B (Minimalist / Performance Focus):** *"Lightweight Deno-native services. Massive scalability. Zero-setup developer dashboard."*
* **Option C (Typesafe/Ecosystem Focus):** *"The contract-first TypeScript meta-framework. End-to-end type safety across browser, edge worker, database, and saga pipelines."*
---
### 4. Monorepo Visual Design Toolkit
Building a stunning, high-appeal monorepo readme requires a clear understanding of what markdown and HTML features can render correctly. The following matrix contrasts how standard elements render in GitHub vs. JSR:
| Markdown / HTML Device | GitHub Render | JSR / npm Registry Render | Remediation / Safe Pattern |
| :--- | :--- | :--- | :--- |
| **`<picture>` Dark Scheme Swap** | **Perfect.** Displays background scheme-appropriate logos. | **Degraded / Stripped.** JSR parser resolves to a static fallback `img` element. | Map the fallback `img src` inside the `<picture>` to a monochromatic or transparent logo that looks exceptional on both solid white and deep dark/grey panels. |
| **Relative Anchors (`./docs/`)** | **Perfect.** Opens files locally. | **Completely Broken.** JSR serves files from `jsr.io` resulting in 404 targets. | Always resolve workspace resource targets inside package registries using absolute URL links pointing directly to `https://rickylabs.github.io/netscript/...`. |
| **Badge Rows (Shields.io)** | **Perfect.** Aligns horizontally. | **Clean.** Standard alignment renders identically. | Limit inline badge definitions to 3–4 high-impact shields (JSR version, build status, license). |
| **Interactive Collapsible `<details>`** | **Perfect.** Synthesizes clean open/close drawers. | **Varies.** Works on JSR, but style tags or nested elements inside the drawer are stripped. | Keep `<details>` content strictly to standard markdown text and standard triple-backtick code blocks. Do not nest custom HTML tables inside. |
| **GitHub flavored Alert Callouts** | **Perfect.** Renders with colorful visual icons. | **Basic Blockquote.** Displays as a styled gray quote indentation. | Standard blockquote wrappers like `> [!NOTE]` convert safely. Use them liberally as they degrade elegantly to readable text. |
---
### 5. Monorepo Landing Anti-Patterns
1. **The Candor Sincerity Gimmick:** Suffixing status comments with phrases like *"We are honestly working on this when we have time"*. This violates repo voice doctrine. Replace with: *"Core plugins are under active alpha testing and subject to refinement."*
2. **Missing Package Discovery Map:** Forcing users to click through folder structures to find out what `@netscript/sagas` or `@netscript/workers` actually does. Every first-party plugin must be summarized in a unified package discovery table on the home page.
3. **White-Box Logo Clipping:** Uploading a custom dark-outline logo without transparency, causing a solid, distracting white rectangle to render behind the logo on GitHub's dark theme readers.
4. **Local CLI Command Omission:** Omitting dev runner directions from the root and forcing developers to refer to sub-directories to find basic task parameters.
,old_str:# State-of-the-Art README Dossier: NetScript Revamp Blueprints
This dossier contains the research findings, patterns, canonical skeletons, quality checklists, and visual design toolkits for the complete revamp of the NetScript repository READMEs. It is organized into two distinct research tracks:
1. **Track 1: Package READMEs** – For the 31 individual packages within the NetScript monorepo.
2. **Track 2: Framework Landing README** – For the root of the NetScript workspace.
---
## NetScript Core Ground Truth & Voice Doctrine
To ground all authoring and design decisions, the following facts and constraints are absolute:
* **Maturity & Version:** Alpha stage (`0.0.1-alpha.1`). This must be clearly surfaced without sounding apologetic or overly verbose.
* **Architecture:** A Deno-native, JSR-published meta-framework orchestrating a plugin architecture over Hono + oRPC + Fresh + .NET Aspire.
* **Core Ecosystem Plugins:** `workers`, `sagas`, `triggers`, `streams`, `auth`.
* **Installation:** Uses JSR natively: `deno add jsr:@netscript/<pkg>`.
* **Documentation Hub:** Features a full documentation site published at [rickylabs.github.io/netscript](https://rickylabs.github.io/netscript/) with per-package reference pages at `/reference/<pkg>/`, tutorials, capability maps, and explanation guides. We cross-link aggressively with absolute URLs to avoid duplicating content and prevent drift.
* **Voice Doctrine:** Authoritative, high-signal, engineering-excellence focused, and descriptive. Absolutely NO candor-announcing framing or words like "honest", "honestly", or "honesty".
---,path:/home/runner/work/netscript/netscript/.llm/tmp/run/docs-readme-revamp/sota-readme-dossier.md,security_risk:MEDIUM,summary:Write full track findings and canonical skeletons to sota-readme-dossier.md.}
Run: https://github.com/rickylabs/netscript/actions/runs/28069821979
…es, gates) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018fq9V7ujx7e1rWXi57qkPG
|
@openhands-agent model=openrouter/google/gemini-3.5-flash provider=openrouter output=pr-comment iterations=400 use harness — deep-search research run, RETRY (the prior run CRITICAL — how to write (the prior run failed exactly here)
The task (full brief on the branch)You are on branch
Hard constraints
When done, post a short index of the dossier (the section headings you wrote) in this PR thread so completion is verifiable. |
OpenHands Agent — CompletedModel: openrouter/google/gemini-3.5-flash OpenHands Run SummaryThis run successfully completed the research and compiled the SOTA README Dossier, strictly complying with the instructions and tracks of the deep-search brief. SummaryThe purpose of this run was to analyze state-of-the-art NPM, Deno, JSR, Rust, and Go project documentation to create a professional guidelines dossier ( All objectives have been successfully achieved:
Changes
Validation
Responses to Review Comments / Issue Comments
Remaining Risks
Run: https://github.com/rickylabs/netscript/actions/runs/28071679235 |
…rified SOTA dossier Fold Track 1 of sota-readme-dossier.md into a concrete C1 authoring contract (authoring-spec.md): adopted 3-badge row, 3-runtime install, emoji signposts, quality checklist + anti-patterns; three NetScript overrides flagged for PLAN-EVAL (unversioned imports per D6, stricter D4 Documentation section w/o placeholder Discord, no per-package maturity callout). Point plan.md D3/C0 at it. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
…to PR2 spec - XREF-1: streams + streams-core target durable-workflows (verified against durable-workflows/index.md "triggers and streams" ref card), not background-processing. - XREF-2: cli has no pillar hub -> link /reference/cli/ + a real scaffold tutorial. - XREF-3: hub-level family ref is meaningful (pillar links one ref per family). - plan.md D2: add durable-workflows family agent (sagas/triggers/streams/*-core).
|
@openhands-agent model=openrouter/minimax/minimax-m3 provider=openrouter output=pr-comment iterations=120 use harness — PLAN-EVAL for PR2 (package README revamp, PR #117). You are the PLAN-EVAL evaluator, a separate session from the generator. Read SKILL
What to read (branch
|
OpenHands Agent — Agent failedModel: openrouter/minimax/minimax-m3 OpenHands Agent Summary — INCOMPLETE (iteration limit)The agent hit the maximum iterations limit (120) before Re-trigger with a narrower task or a higher Run: https://github.com/rickylabs/netscript/actions/runs/28097120347 |
|
@openhands-agent model=openrouter/minimax/minimax-m3 provider=openrouter output=pr-comment iterations=200 use harness — PLAN-EVAL for PR2 (package README revamp, PR #117). You are the PLAN-EVAL evaluator, a separate session from the generator. Read MECHANICS (a prior run exhausted its iteration budget — be decisive)Your #1 deliverable is the VERDICT FILE. Budget your steps: read the four artifacts once, run the SKILL
What to read (branch
|
OpenHands Agent — Agent failedModel: openrouter/minimax/minimax-m3 OpenHands Agent Summary — INCOMPLETE (iteration limit)The agent hit the maximum iterations limit (200) before Re-trigger with a narrower task or a higher Run: https://github.com/rickylabs/netscript/actions/runs/28100028605 |
|
@openhands-agent model=openrouter/minimax/minimax-m3 provider=openrouter output=pr-comment iterations=250 use harness — PLAN-EVAL for PR2 (package README revamp, PR #117). Separate-session plan gate. Two prior runs exhausted their iteration budget by over-exploring. This prompt is deliberately narrow: your ONLY deliverable is the verdict file. Budget hard. MECHANICS — read first, do exactly this, then STOP
SKILL
The plan author has ALREADY ground-truth-verified the cross-ref map
Verdict must answer (one short evidence line each — be decisive)
If a cross-ref claim is wrong, an override is weak, or the link gate is not enforceable → |
OpenHands Agent — CompletedModel: openrouter/minimax/minimax-m3 Run 28102651876-1 — PLAN-EVAL verdict for PR #117 (package README revamp, PR2)SummaryIssued the PASS verdict for the PR2 package README revamp plan, per Changes
Spot-check evidence (per step-2 commands)
Verdict reasoning (4 questions, decisive)
Validation
Responses to review comments or issue commentsN/A — this run produced a plan-gate verdict, no PR review-thread interactions (output_mode was Remaining risks
|
…revamp Separate-session plan gate per .llm/harness/gates/plan-gate.md. Spot-checked XREF-1/XREF-2 against live docs/site pages; all 4 override and gate-set questions resolved with decisive evidence. Plan-gate checklist all boxes checked. Verdict: PASS — C1 authoring may begin. Co-authored-by: openhands <openhands@all-hands.dev>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
… glob Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
…exist; D5 premise wrong) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
…cs to skills The 26 in-package docs/ folders (162 stub files) predate the published docs site and are superseded by it; the revamped READMEs cross-reference the site, not these stubs. The docs/**/*.md publish glob was already dropped (PR2 C1), so nothing shipped to JSR. This removes the folders from the tree per the zero-legacy / JSR-publish-prep mandate. Two skills depended on four of these files as load-bearing contracts, so those are RELOCATED into the owning skill (not lost): - fresh-ui-horizontal authority chain -> l0-conventions.md + theme-authoring.md - netscript-cli Source Docs -> commands.md + maintainer-cli.md SKILL.md refs repointed to the skill-local copies; .claude/skills mirror regenerated (sync-claude OK, validate-claude-surface ok). One scaffold-template comment repointed off the deleted path. arch-debt AS7 doc-warning note updated. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
…hard link gate) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
|
@openhands-agent model=openrouter/qwen/qwen3.7-max provider=openrouter output=pr-comment iterations=1200 use harness You are the IMPL-EVAL evaluator (separate session from the generator) for PR #117 — This PR is one slice of the "road to JSR publish" program. Its goal: every in-package README SKILLActivate and follow these repo skills before evaluating (read each
Context to read first
What to evaluate (per-package verdict — all 31 READMEs)Produce a per-package table. For EACH README, evaluate these dimensions and mark
Repo-wide gates (single verdict each)
Output
Lock & hygiene rules (do NOT violate)
|
OpenHands Agent — CompletedModel: openrouter/qwen/qwen3.7-max IMPL-EVAL Summary: PR #117 (docs/readme-revamp)Verdict: FAIL_FIXSummaryEvaluated all 31 in-package README files (26 packages + 5 plugins) against 10 harness gates for the "road to JSR publish" PR that replaces READMEs with from-scratch, industry-standard documentation cross-referencing the published docs site. Core objective achieved: All 31 READMEs now have verified cross-ref links, professional 9-section structure, voice-compliant content, and zero dead Passing Gates (8/10)
Blocking Issues (Gate 7: publish-glob correctness)Two minor config-hygiene failures require fixes: Issue A:
|
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
…AL (Gate 7) IMPL-EVAL (OpenHands qwen3.7-max) returned FAIL_FIX with 8/10 gates passing and two minor Gate-7 config-hygiene issues: - packages/cli/deno.json: removed a `//` JSONC comment inside compilerOptions that failed the strict-JSON gate (Deno parsed it as JSONC fine, but it was not valid strict JSON). The rationale it carried: isolatedDeclarations is a temporary Wave 6 CLI carve-out for Deno 2.8 isolatedDeclarations annotations. - packages/fresh-ui/deno.json: removed the orphaned `"!docs/**/*.md"` entry from publish.exclude — the docs/ folder was deleted in f92cee1 so the glob was dead weight. Verified: both files strict-JSON valid, `deno check` emits no unsupported-compiler -options warning, `deno task publish:dry-run` exit 0 (all packages pack). No lock churn. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
…ixes Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
|
@openhands-agent model=openrouter/qwen/qwen3.7-max provider=openrouter output=pr-comment iterations=250 use harness You are the IMPL-EVAL re-check evaluator (separate session) for PR #117 — Your prior verdict and the full per-package table are in SKILL
Re-verify (Gate 7 only — the rest already PASSed and are unchanged by these 2 edits)
Output
|
OpenHands Agent — CompletedModel: openrouter/qwen/qwen3.7-max IMPL-EVAL Re-check — PR #117
|
| File | Fix | Evidence |
|---|---|---|
packages/cli/deno.json |
Removed // JSONC comment from line 45 (strict JSON restored) |
python3 json.load ✅; grep for // comments empty; deno check no "Unsupported compiler options" warning |
packages/fresh-ui/deno.json |
Removed orphaned "!docs/**/*.md" from publish.exclude |
python3 json.load ✅; grep for orphan glob empty; other exclude globs intact |
Validation
| Regression Check | Result |
|---|---|
docs/**/*.md include glob in any of 31 deno.json |
❌ None found |
Per-package docs/ dirs under packages/ and plugins/ |
0 (only template scaffold at packages/plugin/src/templates/skeleton/docs, expected) |
All 31 deno.json files strict-JSON valid |
✅ 31/31 |
deno task publish:dry-run raw exit code |
0 ("Success Dry run complete") |
| Lock churn from dry-run | Not triggered |
deno check packages/cli/mod.ts — "Unsupported compiler options" warning |
Not emitted |
Remaining Risks
- MARGINAL (informational only, non-blocking):
packages/fresh-ui/README.mduses a code-block intro format instead of a bold-formatted line. Accepted; no action required. - The
isolatedDeclarations: falseinpackages/cli/deno.jsoncompilerOptions is still present as intended (the fix only removed the JSONC comment above it, not the setting itself).
Updated Gate Table
| # | Gate | Result |
|---|---|---|
| 1 | Cross-Ref Link Resolution | PASS |
| 2 | Cross-Ref Meaningfulness | PASS |
| 3 | No Dead ./docs/* Links |
PASS |
| 4 | API Ground-Truth | PASS |
| 5 | Voice Check | PASS |
| 6 | Industry-Standard Structure | PASS (marginal: fresh-ui) |
| 7 | Publish-Glob Correctness | PASS ← was FAIL_FIX |
| 8 | /docs Folders Gone |
PASS |
| 9 | Skill Repoint Integrity | PASS |
| 10 | Publish Dry-Run | PASS |
PR #117 is ready to merge.
Re-check artifacts: .llm/tmp/run/docs-readme-revamp/evaluate.md (updated with "Re-check (a85d0fc)" section).
Performed by OpenHands IMPL-EVAL re-verification session on behalf of the reviewer.
Run: https://github.com/rickylabs/netscript/actions/runs/28107721013
…dme-revamp # Conflicts: # packages/config/docs/getting-started.md # packages/config/docs/recipes/plugin-schemas.md
PR2's README revamp turned main's README doctests red (3 failed | 874
passed on ci/check-test) by:
- changing the @netscript/sdk Usage fence from `ts` to `typescript`
and dropping the `json` fence (the doctest matches `ts`/`json`);
- removing the @netscript/service createService/auth code example.
Failing tests:
- packages/sdk/tests/readme-doctest_test.ts (ts + json fences)
- packages/service/tests/_fixtures/readme-examples_test.ts (lifecycle APIs)
README-only fix (no source/test changes):
- sdk: relabel the Usage fence `typescript` -> `ts` so the doctest
type-checks it against its prelude; add a `json` import-map fence.
- service: restore the proven createService().withAuthn().serve() and
defineService(..., { auth: {...} }) examples carrying the pinned
lifecycle substrings.
All 4 doctests pass locally; deno fmt --check clean.
Claude-Session: https://claude.ai/code/session_014gW4zfhMMQU6txC828ijct
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
Package + framework README revamp (PR2 — doc-authoring lane)
Rewrites all 31 in-package READMEs from scratch to an industry-standard bar, and seeds the
root repo README (PR3, follow-up) — the front door for the published
@netscriptframework.Doc-authoring lane (no
packages/source): OpenHands+Gemini deep search → Claude authoring workflow→ OpenHands per-package eval. Must merge before the JSR release tag is pushed (READMEs are part of
the JSR publish surface).
Phases
openrouter/google/gemini-3.5-flash: SOTA packageREADMEs and SOTA monorepo/framework-landing READMEs (visual standout, design tricks). Dossier:
.llm/tmp/run/docs-readme-revamp/sota-readme-dossier.md. Brief:.llm/tmp/run/docs-readme-revamp/deep-search-brief.md.deno doc/source;remove dangling
./docs/*.mdlinks (~6 READMEs) + stripdocs/**/*.mdfrom thosedeno.jsonpublish globs; cross-link the published docs at
https://rickylabs.github.io/netscript/<section>/with every link verified to resolve and be meaningful.
Status
🤖 Generated with Claude Code