Skip to content

[AAASM-5016] πŸ“ (docs): improve Quick Start β€” complete end-to-end + dashboard screenshots#326

Open
Chisanan232 wants to merge 7 commits into
mainfrom
v0.0.1/AAASM-5016/docs/golden_path_page
Open

[AAASM-5016] πŸ“ (docs): improve Quick Start β€” complete end-to-end + dashboard screenshots#326
Chisanan232 wants to merge 7 commits into
mainfrom
v0.0.1/AAASM-5016/docs/golden_path_page

Conversation

@Chisanan232

@Chisanan232 Chisanan232 commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

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 the
served 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) and
ghcr.io/ai-agent-assembly/aa-gateway:v0.0.1-rc.6 (loaded both schemas):

  • AAASM-4991 β€” default mode governs nothing. Documented that real
    enforcement requires mode: "napi-inprocess" and enforcementMode: "enforce"; the default mode: "auto" routes through an allow-all no-op
    client and never denies.
  • AAASM-4992 β€” gatewayUrl is overloaded. Documented that in
    napi-inprocess mode it is the aa-runtime UDS socket path
    (/tmp/aa-runtime-<agentId>.sock, or AA_RUNTIME_SOCKET), not an http URL;
    registration uses AA_GATEWAY_ENDPOINT (default 127.0.0.1:50051).
  • AAASM-4996 β€” policy schema. Replaced the rejected rule-list example with
    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.
  • Install pins @0.0.1-rc.6 and warns that the latest dist-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 the
unversioned and versioned pages). Honest captions/alt text; the audit shot's top
row is a policy deny.

Honesty / product-blocked step

  • AAASM-4997 β€” approvals not exercisable in Node at rc.6. The page states
    plainly that the Node SDK has no approval channel yet, so a
    requires_approval tool fail-closes to a deny under enforce. No fake
    pending/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 images
    resolve into build/img/dashboard/.
  • Generated blocks unchanged: node ./scripts/generate-docs-metadata.mjs reports
    "no generated blocks required rewriting" (drift check green).

Jira

https://lightning-dust-mite.atlassian.net/browse/AAASM-5016

Closes AAASM-5016

Chisanan232 and others added 4 commits July 23, 2026 11:28
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>
@Chisanan232 Chisanan232 changed the title [AAASM-5016] πŸ“ (docs): add Start Here Golden Path page [AAASM-5016] πŸ“ (docs): improve Quick Start β€” complete end-to-end + dashboard screenshots Jul 23, 2026
@codecov

codecov Bot commented Jul 23, 2026

Copy link
Copy Markdown

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.
@Chisanan232

Copy link
Copy Markdown
Contributor Author

πŸ“Έ Added the operator dashboard Overview screenshot (ThemedImage light + dark) at the register step in both the current docs/02-quick-start and the version-0.0.1-rc.6 versioned quick start β€” showing the agent appears the moment it registers. Real dashboard UI, sample fixture data (dashboard Playwright + fixture harness).

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.

pnpm build (Docusaurus) green; overview images resolve on both pages.

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>
@Chisanan232

Chisanan232 commented Jul 23, 2026

Copy link
Copy Markdown
Contributor Author

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 docs/02-quick-start/ and the version-0.0.1-rc.6 snapshot. Docusaurus pnpm build passes.

@Chisanan232

Copy link
Copy Markdown
Contributor Author

Refreshed the Topology screenshot (topology-light.png / topology-dark.png, same paths) to the new edges view β€” the graph now draws the relationships between agents (per-kind delegation/call arrows plus curved cross-team connectors), landed in agent-assembly PR #1648 (AAASM-5019, the design-fidelity gap). Re-captured at 1440Γ—900 in both themes via the fixture harness. Docs build verified locally after the swap. Image-only change; no text edits.

@sonarqubecloud

Copy link
Copy Markdown

@Chisanan232

Copy link
Copy Markdown
Contributor Author

πŸ€– 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. mergeStateStatus: BLOCKED = REVIEW_REQUIRED only, not CI.

Scope (AAASM-5016): βœ… Matches. docs/02-quick-start/index.md (+ the rc.6 versioned snapshot) is the reworked arc β€” install β†’ connect β†’ allow β†’ deny β†’ approval β†’ interpret errors β†’ observe (ThemedImage light/dark Overview/Fleet/Topology/Audit) β†’ tune + enforcementMode: "observe" β†’ examples. No separate Golden Path page against base. Honest rc.6 accuracy: default mode: "auto" is an allow-all no-op; real enforcement needs mode: "napi-inprocess" + enforcementMode: "enforce"; gatewayUrl overloading documented; section-based policy schema (rule-list refused); requires_approval fail-closes to deny (no fake pending flow).

Side-effects: βœ… Docs + 8 real PNGs (website/static/img/dashboard/) only. No source/build change. Themed images resolve via useBaseUrl β€” pnpm build with onBrokenLinks: throw is green in CI.

FE: N/A β€” static PNGs in a Docusaurus page, not app FE β†’ Playwright N/A.

Verdict: READY β€” pending Pioneer approval.

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