[AAASM-5016] π (docs): improve Quick Start β complete end-to-end + dashboard screenshots#326
[AAASM-5016] π (docs): improve Quick Start β complete end-to-end + dashboard screenshots#326Chisanan232 wants to merge 7 commits into
Conversation
Add a wayfinding page presenting the full 12-step developer arc (achieve β prereqs β install β connect β allow β deny β approval β observe β tune β operate β examples β core-value), each step linking to the canonical node-sdk page or the shared docs hub. Placed at the top of the sidebar via the `00-` prefix (autogenerated sidebar). Added to both the unversioned source and the served rc.6 versioned snapshot so it appears on the live site now and in future versions. Refs AAASM-5016, AAASM-5013 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Vendored real dashboard captures for the Quick Start OBSERVE step: the Fleet view (registered agents + enforcement mode) and the Audit Log (a policy deny on the top row), each in light and dark for ThemedImage. Served from Docusaurus static assets at /img/dashboard/. Refs AAASM-5016, AAASM-5017 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The wayfinding arc is folded into the Quick Start itself, so the standalone orientation page is redundant. Removed from both the unversioned source and the served rc.6 versioned snapshot. Refs AAASM-5016 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Turn the Quick Start into one guided arc β install, connect, allow, deny, approval, interpret errors, observe (dashboard screenshots), tune a policy and re-run, examples, done β and fix rc.6 accuracy bugs verified against the published @agent-assembly/sdk@0.0.1-rc.6 and aa-gateway:v0.0.1-rc.6: - Default mode governs nothing (AAASM-4991): document that real enforcement needs mode "napi-inprocess" + enforcementMode "enforce"; the default routes through an allow-all no-op client. - gatewayUrl is overloaded (AAASM-4992): in napi-inprocess mode it is the aa-runtime UDS socket path, not an http URL; registration uses AA_GATEWAY_ENDPOINT. - Policy example schema (AAASM-4996): replace the rejected rule-list schema with the real section-based schema (verified: rule-list is refused, the section-based document loads into the rc.6 gateway). - Install pins @0.0.1-rc.6 and notes the latest dist-tag is stale (rc.5). - Approval is honestly marked not exercisable in Node at rc.6 (AAASM-4997): a requires_approval tool fail-closes to deny. Embed the fleet + audit dashboard screenshots (ThemedImage, light + dark) at the OBSERVE step with honest captions/alt text. Applied to both the unversioned source and the served rc.6 versioned snapshot. Refs AAASM-5016, AAASM-4991, AAASM-4992, AAASM-4996, AAASM-4997 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Codecov Reportβ All modified and coverable lines are covered by tests. π’ Thoughts on this report? Let us know! |
Embed the operator dashboard Overview (ThemedImage light + dark) right after the governance-wiring/register step in both the current and version-0.0.1-rc.6 quick starts. Real dashboard UI, sample fixture data.
|
πΈ Added the operator dashboard Overview screenshot ( Topology was retried with a cleaner fixture but dropped β the graph has no D3 collision force, so intra-team nodes overlap and narrow single-node clusters wrap the budget-bar label over the cluster title. Not embedding a garbled image.
|
Embed the operator dashboard Topology view (light + dark ThemedImage) after the Fleet figure in the observe step, in both the unversioned quick-start and the version-0.0.1-rc.6 snapshot. Captured from the real dashboard UI with sample fixture data (two team clusters). Refs AAASM-5016 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
Pushed a new commit to this branch adding the operator dashboard Topology view (light + dark) at the observe step, alongside the existing Fleet/Audit shots. The screenshots were captured from the real dashboard UI after the topology node-overlap fix (AAASM-5018, agent-assembly PR #1647) β same fixture-harness pattern (fixed 1440Γ900, both themes, sample two-team fixture). Docs build verified locally. Not merging. Added to both the unversioned |
|
Refreshed the Topology screenshot ( |
|
|
π€ Claude Code β PR review CI: β
All green β full test-matrix (18/20/22/24 Γ ubuntu/macos/windows), napi-build, publish-docs build, pre-commit, module smoke, SonarCloud Code Analysis SUCCESS, codecov/patch SUCCESS. Scope (AAASM-5016): β
Matches. Side-effects: β
Docs + 8 real PNGs ( FE: N/A β static PNGs in a Docusaurus page, not app FE β Playwright N/A. Verdict: READY β pending Pioneer approval. |



What & why
Reworks the node-sdk Quick Start into a complete, honest, illustrated
end-to-end walkthrough and removes the separate "Start Here / Golden Path"
page added earlier in this PR (its arc is folded into the Quick Start).
The Quick Start is now one guided arc: install β connect β allow β deny β
approval β interpret errors β observe (dashboard screenshots) β tune a policy
and re-run β examples β done.
Applied to both the unversioned source (
docs/02-quick-start/) and theserved rc.6 snapshot (
website/versioned_docs/version-0.0.1-rc.6/02-quick-start/)so the live rc.6 site (
docs.agent-assembly.com/node-sdk/quick-start/) updates.rc.6 accuracy fixes (verified against published artifacts)
Verified against
@agent-assembly/sdk@0.0.1-rc.6(npm) andghcr.io/ai-agent-assembly/aa-gateway:v0.0.1-rc.6(loaded both schemas):enforcement requires
mode: "napi-inprocess"andenforcementMode: "enforce"; the defaultmode: "auto"routes through an allow-all no-opclient and never denies.
gatewayUrlis overloaded. Documented that innapi-inprocessmode it is the aa-runtime UDS socket path(
/tmp/aa-runtime-<agentId>.sock, orAA_RUNTIME_SOCKET), not an http URL;registration uses
AA_GATEWAY_ENDPOINT(default127.0.0.1:50051).the real section-based schema. Verified: the rule-list shape is refused by
the rc.6 gateway (
unsupported rule-list policy schema (top-level 'rules:'));the section-based document loads cleanly and the gRPC server starts.
@0.0.1-rc.6and warns that thelatestdist-tag is stale(currently
rc.5).Dashboard screenshots (OBSERVE step)
Embedded the real fleet + audit dashboard captures via Docusaurus
ThemedImage(light + dark), served from
website/static/img/dashboard/(shared by both theunversioned and versioned pages). Honest captions/alt text; the audit shot's top
row is a policy deny.
Honesty / product-blocked step
plainly that the Node SDK has no approval channel yet, so a
requires_approvaltool fail-closes to a deny underenforce. No fakepending/approved flow is shown.
How to verify
cd website && pnpm install --ignore-workspace && pnpm buildβ build succeeds;onBrokenLinks: "throw"validated all links/anchors and the four themed imagesresolve into
build/img/dashboard/.node ./scripts/generate-docs-metadata.mjsreports"no generated blocks required rewriting" (drift check green).
Jira
https://lightning-dust-mite.atlassian.net/browse/AAASM-5016
Closes AAASM-5016