Skip to content

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

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#298
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

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:

  1. Install the SDK and confirm the version.
  2. Start the governance runtime β€” the published
    ghcr.io/ai-agent-assembly/aa-runtime:v0.0.1-rc.6 sidecar enforcing a local
    policy.toml.
  3. Connect and register the agent with init_assembly() (and the underlying
    RuntimeClient.connect/register).
  4. Govern a tool call β€” the same call shown allowed, denied, and
    held for approval via query_policy(), and how a framework adapter raises
    ToolExecutionBlockedError on deny.
  5. Interpret the outcome through the real exception hierarchy.
  6. Observe the agent β€” real light/dark Fleet and Audit Log dashboard
    screenshots (the audit shot shows a policy deny).
  7. Tune a policy and re-run (plus enforcement_mode="observe" dry-run).
  8. Explore framework examples β€” the CI-generated framework-tabs block,
    preserved verbatim.

rc6 accuracy fixes (AAASM-4987 / AAASM-4988)

  • Every import is a real published symbol verified against
    agent-assembly==0.0.1rc6 in a scratch venv: init_assembly, RuntimeClient
    (connect / register / query_policy), ToolExecutionBlockedError,
    PolicyError, MCPToolBlockedError, and PolicyViolationError (imported from
    agent_assembly.exceptions, since it is not re-exported at top level). No
    more LocalPolicyEngine / top-level PolicyViolationError ImportError traps.
  • The deployment wiring is the real, verified limited-function self-host path:
    the published aa-runtime image enforcing a local policy.toml
    (blocked_actions β†’ deny, requires_approval_actions β†’ pending), with an
    honest note that the central gateway brain, populated data API, and dashboard
    data are SaaS-only.
  • All version references point at 0.0.1rc6.

Type of Change

  • πŸ“š Documentation update

Breaking Changes

  • No

Related Issues

  • Related JIRA ticket: AAASM-5016

Testing

  • mkdocs build --strict passes in an isolated venv (imports, internal links,
    and both dashboard images resolve).
  • Quick-start framework-tabs drift check green
    (scripts/generate_quickstart_tabs.py reports "Up to date").
  • No tests required β€” docs-only change.

Checklist

  • Code follows project style guidelines
  • Self-review completed
  • Documentation updated if needed
  • All checks passing (strict docs build + tabs drift)

Chisanan232 and others added 4 commits July 23, 2026 11:25
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>
@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
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.
@Chisanan232

Copy link
Copy Markdown
Contributor Author

πŸ“Έ 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. mkdocs build --strict green; new images resolve.

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>
@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. β€” mkdocs build --strict 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.

@Chisanan232

Copy link
Copy Markdown
Contributor Author

πŸ€– 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). mergeStateStatus: BLOCKED is REVIEW_REQUIRED only (β‰₯1 Pioneer approval), not a CI problem.

Scope (AAASM-5016): βœ… Matches. docs/quick-start.md is the reworked complete arc β€” install β†’ start aa-runtime sidecar β†’ connect/register (init_assembly / RuntimeClient.connect/register) β†’ govern a tool call (allow / deny / hold-for-approval via query_policy, adapter ToolExecutionBlockedError) β†’ interpret errors β†’ observe (light/dark Overview + Fleet + Topology + Audit screenshots, audit shows a deny) β†’ tune + enforcement_mode="observe" β†’ framework examples. No separate "Golden Path" page against base (added+removed within the PR). Every import is a real rc.6 symbol (init_assembly, RuntimeClient, query_policy, ToolExecutionBlockedError, PolicyViolationError/MCPToolBlockedError/PolicyError/GatewayError from agent_assembly) β€” no LocalPolicyEngine / ImportError trap.

Side-effects: βœ… Docs + PNG assets only (docs/quick-start.md + 8 real PNGs 80–140 KB under docs/images/dashboard/). No code/build behavior changed. Image paths (images/dashboard/*.png#only-light/dark) resolve β€” strict mkdocs build is green in CI.

FE: N/A β€” static PNGs embedded in a docs page, not app front-end β†’ 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