Skip to content

docs: root README + Architecture accuracy pass (ai-autopilot framework + connectors family)#132

Merged
suleimansh merged 1 commit into
mainfrom
docs/autopilot-framework-freshen
Jul 2, 2026
Merged

docs: root README + Architecture accuracy pass (ai-autopilot framework + connectors family)#132
suleimansh merged 1 commit into
mainfrom
docs/autopilot-framework-freshen

Conversation

@suleimansh

@suleimansh suleimansh commented Jul 2, 2026

Copy link
Copy Markdown
Member

Two accuracy gaps in the root docs, same "make the README/Architecture match what shipped" goal.

1. ai-autopilot was described as just its Supervisor seed.

  • README.md — the ai-autopilot row expanded to the full AI-building framework (personas/presets, runner, surfaces, decisions ledger, the loop + prompt library, bootstrap, scale mode); examples line now lists all three quickstarts.
  • Architecture.md — its ai-autopilot section said "parked as a design sketch / records direction, not a committed API", contradicting the doc's own header and ship-order table. Rewritten to "shipped", keeping the design rule and enumerating what got built.
  • docs/packages/ai-autopilot.md — added a "framework layers" overview (it's the README's linked Guide) and corrected the deferred-scope note.

2. The connectors family was missing entirely.
@gemstack/connectors + connector-github + connector-google-drive exist and are documented (docs/packages/connectors*.md) but were never added to the README table or the layering diagram.

  • README.md — added the three package rows, put connectors in the "how they fit together" diagram (on the mcp axis, not ai-*), and added a short "Connectors" subsection explaining the defineConnector / mountConnectors contract and the extensible connector-* pattern.
  • Architecture.md — added a "Connectors (built on @gemstack/mcp)" section on the server-framework axis.

Note: the connectors packages are built but not yet published (v0.0.0) — their npm badges resolve once the open release PR #92 merges.

Docs only, no changeset. The VitePress site rebuilds from docs/ in CI.

@suleimansh suleimansh added the documentation Improvements or additions to documentation label Jul 2, 2026
@suleimansh suleimansh self-assigned this Jul 2, 2026
@suleimansh suleimansh added the priority: low Nice to have / latent label Jul 2, 2026
@suleimansh suleimansh merged commit ab221cf into main Jul 2, 2026
2 checks passed
@suleimansh suleimansh deleted the docs/autopilot-framework-freshen branch July 2, 2026 18:19
@suleimansh suleimansh changed the title docs: refresh ai-autopilot from Supervisor-seed to the full framework docs: root README + Architecture accuracy pass (ai-autopilot framework + connectors family) Jul 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation priority: low Nice to have / latent

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant