Skip to content

docs(readme): beta.6 ai + telemetry README pass (shipped surface, one-vocabulary)#610

Merged
rickylabs merged 1 commit into
mainfrom
docs/beta6-readme-pass
Jul 11, 2026
Merged

docs(readme): beta.6 ai + telemetry README pass (shipped surface, one-vocabulary)#610
rickylabs merged 1 commit into
mainfrom
docs/beta6-readme-pass

Conversation

@rickylabs

Copy link
Copy Markdown
Owner

Summary

Single-pass README alignment for everything beta.6 touched, with deno doc as ground truth (shipped surface only):

Refs #609, #601. Markdown-only; no source changes.

Validation

  • doc:lint clean for packages/telemetry and packages/ai
  • deno fmt --check clean on all 10 touched READMEs
  • Every named export verified via deno doc / source before mention; JSR publish state respected (no unpublished-version install claims)

Lane

Claude (Fable 5 low) documentation lane under the CLAUDE.md documentation-authoring exception; supervised by orchestrator fb43bc3e, Tier-A reviewed.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WVCH2JZKKMDJU3A7jxDxPo
@rickylabs rickylabs added this to the 0.0.1-beta.6 milestone Jul 11, 2026
@rickylabs
rickylabs marked this pull request as ready for review July 11, 2026 07:28
@rickylabs
rickylabs merged commit 720fcb7 into main Jul 11, 2026
11 of 14 checks passed
rickylabs added a commit that referenced this pull request Jul 11, 2026
…h:false claims (#448) (#647)

Fills the AI pillar for the beta.7 docs cut (D9):
- ai/index.md: story-template pass — layered stack pitch, two-planes law,
  engine-as-design-center, one factual comparison (Medusa/Convex), MCP card,
  and a beta.7-shipped callout replacing the beta.2-pending state.
- ai/mcp.md: fills the #433 stub — MCP *client* stack story (transports,
  injected auth, multi-server pool, ui:// safe render path), one factual
  Encore-server comparison, explicit "client, not server" non-claim.
- ai/engine.md: replaced "Available from 0.0.1-beta.2 / not published" callout
  with the published beta.7 state; rewrote "Generated runtime registries" as
  direct registry wiring + a caveated "generate ai not shipped" note (shipped
  targets: plugins, runtime-schemas, aspire).
- ai/durable-chat.md: dropped the stale "[beta.2 engine]" framing; pinned the
  JSR line to @netscript/fresh@0.0.1-beta.7.

Every present-tense symbol claim traces to deno doc of the published
@netscript/ai@0.0.1-beta.7 surface (gate satisfied) or the PR #610 READMEs.
Grep clean for beta.2/publish:false and positioning-law forbidden patterns
across the pillar. deno task verify green (build + check:links + check:caveats).

Refs #448


Claude-Session: https://claude.ai/code/session_01DiTbVL2p3zLYc9AxxpK8iG

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
rickylabs added a commit that referenced this pull request Jul 11, 2026
…ery read side (#445) (#649)

Reframe the observability pillar around the build-efficiency law: the verification
turn ("did the change work across every process?") is the expensive turn, and
NetScript closes it inside the framework.

telemetry.md:
- elevator-pitch intro (verification-turn / agent self-verify framing)
- "one grouped trace" story spine (Flow-B: trigger → scheduler → queue →
  job.execute → SDK rpc.client callback; createFanInLinks span links;
  gate-enforced; gen_ai.* for AI turns)
- telemetry ports/adapters + #402 attribute convention mechanism paragraph
- service/RPC/HTTP tracing: registerORPCInstrumentation + first-party
  createHonoTracingMiddleware
- new "Close the loop" section: typed TelemetryQueryPort read side +
  the single factual Encore comparison (MCP trace access vs in-language port)

index.md: pitch-led intro, "read a trace back in code" next-step, convention link.

All present-tense API claims trace to deno doc (query.ts/orpc.ts) + canonical
README (PR #610); published beta.7 surface only. deno task verify green
(build + 23019 links resolve + 27 caveats resolve).

Refs #445


Claude-Session: https://claude.ai/code/session_01DiTbVL2p3zLYc9AxxpK8iG

Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant