Skip to content

docs: update existing pages, ACB theme, README features (Phase 3)#45

Merged
Killea merged 2 commits intoKillea:mainfrom
bertheto:docs/phase3-update
Mar 5, 2026
Merged

docs: update existing pages, ACB theme, README features (Phase 3)#45
Killea merged 2 commits intoKillea:mainfrom
bertheto:docs/phase3-update

Conversation

@bertheto
Copy link
Contributor

@bertheto bertheto commented Mar 5, 2026

Documentation Phase 3 — Update existing pages, ACB theme, README features

This PR completes the documentation effort started in PRs #42 (MkDocs site) and #43 (condensed README).

Axe 1 — Update existing MkDocs pages (accuracy fixes)

docs/reference/rest-api.md — 16 missing endpoints added:

  • Messages: reactions (POST/DELETE/GET), edit (PUT), history (GET)
  • Search (GET /api/search) and Metrics (GET /api/metrics)
  • Threads: settings (GET/POST), admin (GET/POST decision), export (GET), sync-context (POST), agents (GET)
  • Agents: kick (POST)

docs/reference/tools.md — corrections:

  • msg_post: sync fields (expected_last_seq, reply_token) are required for MCP callers (not optional)
  • msg_react/msg_unreact: agent_id is optional (not required)
  • thread_list: documented cursor pagination (limit, before, next_cursor, envelope response)

docs/getting-started/config.md — 6 missing env vars added + corrected default DB path (source mode vs installed package mode)

docs/development/structure.md — added missing data models (MessageEdit, Reaction, ThreadSettings) + new Data Models section

Axe 3 — README improvements

  • Added 8 missing features: bus_connect (one-step), message editing, reactions, FTS5 search, thread templates, admin coordinator, reply-to threading, agent skills
  • Renamed "Zero external dependencies" to "No external infrastructure"
  • Documentation link opens in a new browser tab (target="_blank")

Axe 4 — MkDocs theme aligned with ACB web UI

  • OS theme auto-detection: media queries in mkdocs.yml — site follows system dark/light preference automatically
  • docs/stylesheets/acb-theme.css:
    • Header: dark background #0a0d12 matching ACB --bg-base
    • Title: gradient linear-gradient(135deg, #3b82f6, #a855f7) matching ACB topbar logo
    • Nav tabs: #1e3a8a (dark) / #2563eb (light)
    • Section title on scroll: solid white (readable)
    • Code blocks: #111620 background matching ACB --bg-input
    • Copy button: same background as code block
    • Tables, admonitions, footer aligned with ACB palette

Validated locally with mkdocs serve. No code changes — documentation only.

bertheto added 2 commits March 5, 2026 23:06
Axe 1 - Update existing MkDocs pages:
- rest-api.md: add 16 missing endpoints (reactions, edit, search, metrics,
  thread settings/admin/export/sync-context, agent kick, threads agents)
- tools.md: fix msg_post sync fields (required for MCP), msg_react/msg_unreact
  (agent_id optional), thread_list cursor pagination
- config.md: add 6 missing env vars + correct DB path (source vs package mode)
- structure.md: add MessageEdit, Reaction, ThreadSettings models + Data Models section

Axe 3 - README improvements:
- Add 8 missing features (bus_connect, editing, reactions, search, templates,
  admin coordinator, reply-to threading, agent skills)
- Rename 'Zero external dependencies' -> 'No external infrastructure'
- Documentation link now opens in a new browser tab (target=_blank)

Axe 4 - MkDocs theme aligned with ACB web UI:
- mkdocs.yml: media queries for OS-level theme auto-detection
- docs/stylesheets/acb-theme.css: header dark, accent #3b82f6,
  code blocks, tables, footer matching ACB palette
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.

2 participants