[AAASM-5016] π (docs): improve Quick Start β complete end-to-end + dashboard screenshots#298
[AAASM-5016] π (docs): improve Quick Start β complete end-to-end + dashboard screenshots#298Chisanan232 wants to merge 7 commits into
Conversation
Add a wayfinding page that walks a newcomer through the whole end-to-end journey of governing a Python agent β install, connect, allow, deny, approvals, observe, tune, operate, examples β linking each step to the canonical page that owns it. Register it in the nav right after Introduction so it's the recommended first read. Refs AAASM-5016, AAASM-5013.
Its intent moves into the reworked Quick Start, which now owns the full install β deploy β allow/deny/approval β observe β tune arc directly. Also removes the page's mkdocs.yml nav entry. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Real Fleet and Audit Log views (AAASM-5017), embedded at the Quick Start 'observe your agent' step. Both themes so mkdocs-material #only-light / #only-dark can swap per palette. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Replaces the framework-slice-only page with one guided arc: install β start the aa-runtime enforcement point from a local policy β connect and register β drive one tool call to allow / deny / approval β interpret the outcome via the exception hierarchy β observe in the dashboard β tune a policy and re-run β explore framework examples. Fixes rc6 API accuracy (AAASM-4987/4988): every import is a real published symbol (init_assembly, RuntimeClient connect/register/query_policy, ToolExecutionBlockedError, PolicyError; PolicyViolationError from agent_assembly.exceptions), and the deployment wiring uses the real published ghcr.io/ai-agent-assembly/aa-runtime:v0.0.1-rc.6 image enforcing a local policy.toml, with an honest note on what is SaaS-only. The CI-generated framework-tabs block is preserved verbatim (drift check green). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Show the operator dashboard Overview (light + dark) right after init_assembly()/register β the fleet count ticks up and the three-layer posture goes live the moment an agent registers. Real dashboard UI, sample fixture data.
|
πΈ Added the operator dashboard Overview screenshot (light + dark) at the register/connect step β showing the agent appears the moment it registers (fleet count ticks up, three-layer posture goes live). Real dashboard UI, sample fixture data, captured via the dashboard's own 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 single-node team clusters wrap the budget-bar label over the cluster title. Not embedding a garbled image. |
Embed the operator dashboard Topology view (light + dark) alongside the Fleet and Audit Log shots in step 6, 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. β |
|
Refreshed the Topology screenshot ( |
|
π€ Claude Code β PR review CI: β
All green β Build documentation (PR, no deploy), Quick-start Tabs Drift Check, CodeQL all SUCCESS. No CodeCov/SonarCloud checks configured on this docs PR (docs-only; N/A). Scope (AAASM-5016): β
Matches. Side-effects: β
Docs + PNG assets only ( FE: N/A β static PNGs embedded in a docs page, not app front-end β Playwright N/A. Verdict: READY β pending Pioneer approval. |
Description
Reworks the Python SDK Quick Start into a complete, illustrated, end-to-end
walkthrough, and removes the separate "Start Here β Golden Path" page added
earlier in this PR (its intent now lives inside the Quick Start).
The Quick Start is now one guided arc:
ghcr.io/ai-agent-assembly/aa-runtime:v0.0.1-rc.6sidecar enforcing a localpolicy.toml.init_assembly()(and the underlyingRuntimeClient.connect/register).held for approval via
query_policy(), and how a framework adapter raisesToolExecutionBlockedErroron deny.screenshots (the audit shot shows a policy
deny).enforcement_mode="observe"dry-run).preserved verbatim.
rc6 accuracy fixes (AAASM-4987 / AAASM-4988)
agent-assembly==0.0.1rc6in a scratch venv:init_assembly,RuntimeClient(
connect/register/query_policy),ToolExecutionBlockedError,PolicyError,MCPToolBlockedError, andPolicyViolationError(imported fromagent_assembly.exceptions, since it is not re-exported at top level). Nomore
LocalPolicyEngine/ top-levelPolicyViolationErrorImportError traps.the published
aa-runtimeimage enforcing a localpolicy.toml(
blocked_actionsβ deny,requires_approval_actionsβ pending), with anhonest note that the central gateway brain, populated data API, and dashboard
data are SaaS-only.
0.0.1rc6.Type of Change
Breaking Changes
Related Issues
Testing
mkdocs build --strictpasses in an isolated venv (imports, internal links,and both dashboard images resolve).
(
scripts/generate_quickstart_tabs.pyreports "Up to date").Checklist