Skip to content

docs(site): align plugin/CLI/architecture prose to alpha.13 surface#182

Merged
rickylabs merged 4 commits into
mainfrom
docs/alpha13-surface-accuracy
Jun 30, 2026
Merged

docs(site): align plugin/CLI/architecture prose to alpha.13 surface#182
rickylabs merged 4 commits into
mainfrom
docs/alpha13-surface-accuracy

Conversation

@rickylabs

Copy link
Copy Markdown
Owner

Summary

Aligns the published docs/site prose to the alpha.13 plugin CLI surface before the release Pages build:

  • Renames the literal command surface from plugin add to plugin install across 19 published docs pages, replacing 69 old command mentions.
  • Corrects the public install model: netscript plugin install <kind> accepts official bare aliases such as workers/auth, scoped package specs such as @netscript/plugin-workers, and explicit jsr: specs.
  • Corrects install flag prose to match source and help output: the public command accepts --name, --port, --service-refs, --plugin-refs, --db/--no-db, --saga-store-backend, --samples/--no-samples, --skip-confirmation, --ci, --dry-run, --jsr-url, --local-path, --no-copy-source, --project-root, and --force.
  • Rewords the stale registry/copy-model reference to the workspace-owned registry/thin-dependency model.

Scope

  • Archetype / area: docs/site
  • Docs-only: no packages/ or plugins/ source changes.

Slices

  • S1 command rename and public install argument/flag accuracy — 5f72c97d
  • S2 no-source-copy thin-dependency wording — 98e75454
  • S3 plugin-system install sequence narrative — adacfcf5

Validation

  • cd docs/site && deno task verify — PASS
  • deno task build — PASS, site built into _site
  • deno task check:links — PASS, 18453 internal links across 130 pages all resolve
  • deno task check:caveats — PASS, 30 caveat markers across 23 pages all references resolve

Harness

  • Run dir: .llm/tmp/run/docs-alpha13-surface-accuracy--docs/
  • Phase: impl

Drift / Debt

  • none

@augmentcode

augmentcode Bot commented Jun 30, 2026

Copy link
Copy Markdown
🤖 Augment PR Summary

Summary: Updates the docs/site prose to match the alpha.13 CLI and plugin install surface ahead of release.

Changes:

  • Renames documentation references from netscript plugin add to netscript plugin install across capability pages, how-tos, glossary, and tutorials
  • Refreshes the plugin install narrative to reflect the current “workspace-owned registry / thin dependency” model
  • Aligns CLI reference tables with the public install model (aliases, package specs, and the install flag surface)
  • Updates contributor examples to use netscript-dev ... plugin install where applicable

Technical Notes: This PR is docs-only (no packages/ or plugins/ source changes) and focuses on keeping the published guidance consistent with the alpha.13 CLI/help output.

🤖 Was this summary useful? React with 👍 or 👎

@augmentcode augmentcode Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. 1 suggestion posted.

Fix All in Augment

Comment augment review to trigger a new review at any time.


```bash
netscript plugin add @netscript/plugin-workers
netscript plugin install @netscript/plugin-workers

@augmentcode augmentcode Bot Jun 30, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This snippet omits --name, but the public netscript plugin install command currently treats --name as required (it throws Missing required option: --name). Other locations where this applies: docs/site/capabilities/auth.md:11, docs/site/capabilities/auth.md:95, docs/site/capabilities/auth.md:107, docs/site/capabilities/durable-sagas.md:41, docs/site/how-to/add-authentication.md:36, docs/site/how-to/add-authentication.md:67, docs/site/tutorials/workspace/02-auth.md:58, docs/site/tutorials/workspace/02-auth.md:81, docs/site/tutorials/live-dashboard/05-live-stream.md:34, docs/site/how-to/tune-worker-runtime.md:26.

Severity: medium

Other Locations
  • docs/site/capabilities/auth.md:11
  • docs/site/capabilities/auth.md:95
  • docs/site/capabilities/auth.md:107
  • docs/site/capabilities/durable-sagas.md:41
  • docs/site/how-to/add-authentication.md:36
  • docs/site/how-to/add-authentication.md:67
  • docs/site/tutorials/workspace/02-auth.md:58
  • docs/site/tutorials/workspace/02-auth.md:81
  • docs/site/tutorials/live-dashboard/05-live-stream.md:34
  • docs/site/how-to/tune-worker-runtime.md:26

Fix This in Augment

🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.

…-source-copy wording

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

[PHASE: IMPL] [VERDICT: UPDATE]

Follow-up slice landed and pushed.

Scope

  • Fixed the non-.md command miss in docs/site/concepts.vto: the remaining published netscript plugin add ... reference is now netscript plugin install ....
  • Re-ran the full published-doc sweep with git grep -n "plugin add" -- docs/site ':!docs/site/_plan'; no remaining hits.
  • Reconciled public-install wording to the no-source-copy model: public install runs the plugin package's scaffolder, emits user-owned glue/sample files, and keeps service/runtime/contract/schema internals in the installed package dependency. Contributor/local-source docs still distinguish the source-backed path.

Source Grounding

  • installPlugin() resolves the plugin package, runs runPluginOwnedScaffold(...), then renders CLI-owned support with { importMode: 'jsr' }.
  • runPluginOwnedScaffold() dispatches the package-owned scaffolder from the resolved JSR/local source.
  • First-party scaffolder examples emit glue such as auth/mod.ts, not copied service/runtime/schema internals.

Commit

  • d41a9055docs(site): sweep non-md command rename + reconcile public-install no-source-copy wording

Validation

  • cd docs/site && deno task verify — PASS
  • Build — PASS, 306 files generated
  • check:links — PASS, 18453 internal links across 130 pages all resolve
  • check:caveats — PASS, 30 caveat markers across 23 pages all references resolve

@rickylabs
rickylabs merged commit 1c646ab into main Jun 30, 2026
6 checks passed
@rickylabs
rickylabs deleted the docs/alpha13-surface-accuracy branch June 30, 2026 14:29
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.

1 participant