Skip to content

[AAASM-5017] 📝 (docs): add light/dark dashboard screenshots to observe docs#131

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

[AAASM-5017] 📝 (docs): add light/dark dashboard screenshots to observe docs#131
Chisanan232 wants to merge 7 commits into
mainfrom
v0.0.1/AAASM-5017/docs/dashboard_screenshots

Conversation

@Chisanan232

@Chisanan232 Chisanan232 commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Description

Adds a new Operations hub page — Observe your agents in the Dashboard (docs/src/dashboard.md) — embedding real Dashboard screenshots in both light and dark mode:

  • Fleet (/agents) — the golden-path observe your agents surface (agents across frameworks with mode / status / owner / last-seen).
  • Audit Log (/audit) — the see a denial surface (a DENY on an external gmail/send, alongside allow / redact verdicts).

Each screen is shown as a captioned light + dark pair with descriptive alt text. The page is registered in SUMMARY.md under Operations, and self-host-observability.md gets a reciprocal cross-link.

How the screenshots were produced (honest, real captures): they are the actual dashboard React UI rendered by the dashboard's own Playwright + fixture harness in agent-assembly/dashboard (the established pattern behind audit-log-theme.spec.ts / theme-visual.spec.ts / the design-fidelity specs) — deterministic fixtures + a mocked event stream, no live backend, animations frozen, fixed 1440×900 viewport, both data-theme light and dark. The throwaway capture spec/config were not committed to agent-assembly. The images truthfully show the operator UI; they are not a claim that any live deployment is wired end-to-end (the page says so).

Topology and Policies/Budget were intentionally dropped rather than embedded: Topology's small-node budget labels overlapped (no collision force in the D3 layout) and the Policies/Budget fixture endpoints now return a paginated {items,total} shape that rendered empty. Fleet + Audit cover the AC's agents + decisions screens cleanly.

Type of Change

  • 📝 New documentation page
  • 🐛 Bug fix (correcting inaccurate or missing content)
  • ♻️ Refactor / restructure (no content change)
  • 🔧 Configuration / CI change
  • ✨ New section or feature documentation

Related Issues

  • Related Jira ticket: AAASM-5017 (Story)
  • Parent Epic: AAASM-5013 — Docs-IA Golden Path Quickstart restructure

How to verify

  • cd docs && mdbook build → green (mdBook v0.5.2); book/dashboard.html renders, the 4 PNGs are copied to book/images/dashboard/ and resolve, and the new nav entry appears under Operations.
  • The repo-name, compatibility, and hub-component drift checks all pass.

Documentation Checklist

  • cd docs && mdbook build passes locally with no warnings (only the pre-existing mdbook-mermaid / gettext preprocessor version-mismatch notices)
  • All internal cross-links verified
  • Page registered in docs/src/SUMMARY.md
  • Self-hosted instructions not included (SaaS-only scope) — page describes the OSS operator UI only, no orchestration/deploy instructions
  • "Last reviewed" footer updated with today's date
  • Commits follow GitEmoji convention and are small / atomic

Chisanan232 and others added 4 commits July 23, 2026 11:59
Fleet (observe your agents) and Audit Log (see a denial) captured from the
dashboard's own Playwright + fixture harness in agent-assembly/dashboard —
real UI, deterministic fixtures, both data-theme light and dark, 1440x900.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
New Operations hub page embedding the light/dark Fleet and Audit Log
screenshots with honest captions + descriptive alt text, oriented to the
golden-path observe step. Registered in SUMMARY.md.
Add an Overview section (light + dark) ahead of Fleet — the landing screen
where a newly registered agent appears at a glance via the fleet snapshot and
posture rings. Real Dashboard UI, sample fixture data.
@Chisanan232

Copy link
Copy Markdown
Contributor Author

📸 Added an Overview section (light + dark) ahead of Fleet on the dashboard page — the landing screen where a newly registered agent appears at a glance via the fleet snapshot + posture rings. Real Dashboard UI, sample fixture data.

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.

mdbook build green; overview images resolve in the built book.

Add a Topology section to the Dashboard observe page, between Fleet and
Audit Log, showing the operator dashboard Topology view (light + dark)
captured from the real UI with sample fixture data (two team clusters).

Refs AAASM-5017

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 adding a Topology section to the Dashboard observe page (docs/src/dashboard.md), between Fleet and Audit Log, with light + dark screenshots. Captured from the real dashboard UI after the topology node-overlap fix (AAASM-5018, agent-assembly PR #1647) — fixed 1440×900, both themes, sample two-team fixture. mdbook build passes locally. Not merging.

@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: ⚠️ One red check — "Aggregate all module docs" FAILED, but for a reason unrelated to this PR. The hub mdBook build (which includes this PR's new dashboard.md and copies the 8 PNGs into public/) succeeds; the job then fails later at ==> Cloning ai-agent-assembly/agent-assembly @ mastererror: pathspec 'master' did not match. Root cause: the core agent-assembly repo's default branch was renamed master → main, but modules.json still pins the core module ref: "master", so git checkout master finds no ref. This is pre-existing infra (the scheduled Aggregate runs on main fail the same way; the 03:12 push predated the rename) and is out of scope for a docs-content PR — it needs a separate ticket to bump modules.json core ref to main (likely alongside the other module refs). Not fixing it here. Hub-metadata drift check ✅; SonarCloud SUCCESS ✅. No CodeCov configured (N/A).

Scope (AAASM-5017): ✅ Matches the AC. New docs/src/dashboard.md registered in SUMMARY.md under Operations, with a reciprocal cross-link from self-host-observability.md. Light+dark captioned pairs for the observe surfaces; the Audit shot shows a DENY. Note: the PR body says "Topology … intentionally dropped," but the delivered page embeds Overview + Fleet + Topology + Audit (all 8 PNGs) — the page is more complete than the body describes; the body text is just stale. Not a blocker.

Side-effects: ✅ Docs + 8 real PNGs (docs/src/images/dashboard/, 80–140 KB) + SUMMARY + one cross-link. No code/build behavior changed; mdbook build renders the page and resolves the images (proven by the successful hub-build step in the Aggregate log before the unrelated core clone).

FE: N/A — static PNGs in an mdBook page, not app FE → Playwright N/A.

Verdict: READY — pending Pioneer approval. The one red check is a pre-existing, unrelated aggregate-infra failure (core mastermain rename vs modules.json), not caused by this PR; recommend a separate ticket to update modules.json.

agent-assembly's default branch was renamed master→main; the docs aggregation
registry still pinned core `ref: master`, so `git clone -b master` failed
("pathspec 'master' did not match") and broke the Aggregate job on every docs
PR + scheduled main run. Point core at `main`. All modules now on main.
@sonarqubecloud

Copy link
Copy Markdown

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