docs(site): reconcile to merged #193/#183/#190 surface + fmt-guard config#199
Conversation
…nfig
Brings the doc site current with the three just-merged PRs, and hardens the
standalone docs project config so `deno fmt` can never again reflow Vento
markdown or split its `{{ comp }}` tags.
Content (12 pages):
- #190 fresh-ui: document the AI/workspace primitive catalog (11 L2 primitives
+ command-palette/search) and the headless Combobox interactive namespace;
extra `ui:add` examples. (customize-fresh-ui, capabilities/fresh-ui)
- #193 triggers-oRPC truth: triggers serve a typed v1 oRPC contract for
introspection/management/SSE; only the webhook ingress endpoint
(POST /api/v1/webhooks/:triggerId) stays a raw HMAC-verifying route by design.
Corrected every stale "raw Hono, not oRPC" claim. (triggers, capabilities/index,
contracts, architecture, glossary, deploy, storefront/05-shipping-webhook)
- #183/#172 two-tier plugin shape: `netscript plugin new <name>` emits a
core engine package + thin connector; --kind feature|proxy (default proxy),
--overwrite. (cli-reference, author-a-plugin, plugin-system)
Config:
- docs/site/deno.json gains an fmt block (proseWrap preserve; excludes
**/*.md, **/*.mdx, **/*.vto, _site/, _cache/) and a lint block, so the
authored Markdown/Vento surface is out of scope for `deno fmt`.
Verified: `deno task build` green (306 files); `check:links` green
(18456 internal links across 130 pages resolve). Docs-only; no framework source.
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 output=pr-comment IMPL-EVAL this docs-only PR (#199). It reconciles the doc site to three just-merged PRs. Give a per-domain verdict (PASS / FAIL_FIX per domain), grounded against the actual merged code on Domains to verify:
Also run the docs gates from deno task build Both must be green (expected: 306 files built; ~18456 internal links resolve). Note: Constraints: docs-only PR — flag ANY change outside |
OpenHands Agent — CompletedModel: openrouter/qwen/qwen3.7-max IMPL-EVAL Summary — PR #199 (docs-only reconciliation)Per-Domain Verdicts
Docs Gates
Constraints Check
Remaining Risks
Run: https://github.com/rickylabs/netscript/actions/runs/28485224548 |
🤖 Augment PR SummarySummary: Updates the docs site to match recently merged platform surface changes (triggers oRPC, two-tier plugin scaffolding, fresh-ui primitives) and hardens the docs project’s formatter config. Changes:
docs/site/; intended to prevent formatter reflow from breaking Vento markdown/component tags.
🤖 Was this summary useful? React with 👍 or 👎 |
![augmentcode[bot]](https://avatars.githubusercontent.com/in/1027498?s=60&v=4){kind=small}
| previewing a schedule, enabling/disabling a trigger, and subscribing to an SSE event stream. The one | ||
| deliberate exception is the <strong>webhook ingress endpoint</strong> itself | ||
| (<code>POST /api/v1/webhooks/:triggerId</code>, plus a legacy <code>GET /api/v1/events</code>): it stays | ||
| a <strong>raw, signature-verifying route</strong>, not an oRPC procedure, because it must verify an HMAC |
There was a problem hiding this comment.
docs/site/capabilities/triggers.md:38: GET /api/v1/events is a legacy raw route, but it isn’t signature-verifying like the webhook ingress. Grouping it inside the “raw, signature-verifying route” exception could mislead readers about the behavior/security properties of that legacy endpoint.
Severity: medium
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
| ## Step 4 — Route shape (raw webhook ingress) | ||
|
|
||
| The triggers service serves a typed v1 oRPC contract for trigger and event introspection plus | ||
| management, but the **webhook ingress endpoint** is deliberately a **raw route**, not an oRPC |
There was a problem hiding this comment.
docs/site/tutorials/storefront/05-shipping-webhook.md:170: In Hono, a :triggerId param won’t capture across /, so /api/v1/webhooks/shipping/status is effectively handled via the .../:triggerId/* route and path normalization. The current wording implies :triggerId itself becomes shipping/status, which isn’t how the router pattern matches.
Severity: low
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
…FAIL_FIX) The two-tier topology prose was correct, but the CLI flag spellings were invented. Ground truth (packages/cli/.../new/new-plugin-command.ts): - boolean `--feature` (default proxy) → kind: feature|proxy - boolean `--force` → overwrite - `--project-root <path>` There is no `--kind feature|proxy` flag and no `--overwrite` flag. Running `netscript plugin new billing --kind proxy` would fail. Corrected the two docs that showed the wrong flags: - cli-reference.md: example → `netscript plugin new billing` (proxy default); desc → `--feature` / `--force`. - how-to/author-a-plugin.md: example → `netscript plugin new notifier`; options prose → `--feature` (route-backed feature connector vs default proxy), `--force` (overwrite), `--project-root <path>`. Verified: `deno task build` green (306 files); `check:links` green (18456 internal links across 130 pages resolve). Docs-only. 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 output=pr-comment RE-IMPL-EVAL (cycle 2) for PR #199 — Domain 2 only. Your cycle-1 verdict was Domain 1 PASS, Domain 3 PASS, Domain 2 FAIL_FIX on the Verify only that Domain 2 is now correct, grounded against the actual CLI source (
Confirm both docs now match:
Also re-run the two docs gates from deno task build Expected: build exit 0 (306 files); check:links exit 0 (18456 internal links across 130 pages resolve). Constraints: docs-only PR — flag ANY change outside |
OpenHands Agent — CompletedModel: openrouter/qwen/qwen3.7-max RE-IMPL-EVAL (cycle 2) — PR #199 Domain 2SummaryCycle-2 verification of commit ChangesThe prescribed fix in commit
No changes outside ValidationCLI source truth (ground truth)
Doc 1:
|
2 participants
Summary
Brings the doc site current with the three PRs just merged for the next release cut — #193 (triggers oRPC), #183/#172 (two-tier plugin shape), #190 (fresh-ui AI primitives) — and hardens the standalone docs project config so
deno fmtcan never again reflow Vento markdown or split its{{ comp }}tags.Content (12 pages)
ui:addexamples.how-to/customize-fresh-ui.md,capabilities/fresh-ui.md.POST /api/v1/webhooks/:triggerId) stays a raw HMAC-verifying route by design.capabilities/triggers.md,capabilities/index.md,explanation/contracts.md,explanation/architecture.md,glossary.md,how-to/deploy.md,tutorials/storefront/05-shipping-webhook.md.netscript plugin new <name>emits a core engine package + thin connector;--kind feature|proxy(default proxy),--overwrite.cli-reference.md,how-to/author-a-plugin.md,explanation/plugin-system.md.Config
docs/site/deno.jsongains anfmtblock (proseWrap: preserve; excludes**/*.md,**/*.mdx,**/*.vto,_site/,_cache/) and alintblock, so the authored Markdown/Vento surface is out of scope fordeno fmt. This is the durable fix for the reflow / comp-tag-breakage class of build failures.Verification
deno task build— green, 306 files generated.deno task check:links— green, 18456 internal links across 130 pages resolve.check:caveatsfails only under the linked-worktree layout (the tool can't walk up to.llm/harness/debt/arch-debt.mdfrom this path); no new caveat refs were added, so it resolves on a normal PR checkout.Docs-only — 13 files, +243/-80, all under
docs/site/. No framework source touched.🤖 Generated with Claude Code