Skip to content

docs: refresh root README and Architecture for the full shipped package set#28

Merged
suleimansh merged 1 commit into
mainfrom
docs/root-readme-architecture-freshen
Jun 26, 2026
Merged

docs: refresh root README and Architecture for the full shipped package set#28
suleimansh merged 1 commit into
mainfrom
docs/root-readme-architecture-freshen

Conversation

@suleimansh

Copy link
Copy Markdown
Member

What

The root README was stale from the pilot-package era: it listed only @gemstack/ai-sdk, called the rest of the AI family "planned", and showed version 0.1.0. All five packages have since shipped.

README

  • Lists all five packages (ai-sdk 0.3.0, ai-skills 0.1.0, ai-autopilot 0.1.0, ai-mcp 0.1.0, mcp 0.2.0) with correct descriptions.
  • Adds the dependency-layering diagram and the ai- naming rule.
  • Adds the "which MCP package do I use?" guidance so ai-mcp and mcp never read as duplicates.
  • Points at examples/ and the changeset flow.

Architecture.md

  • Marks the AI family and @gemstack/mcp as shipped.
  • Drops the (later) marker on mcp.
  • Turns the "suggested ship order" into the realized one.

Docs-only. No changeset needed.

…ge set

The root README still listed only @gemstack/ai-sdk, called the rest of
the family "planned", and showed a stale 0.1.0 version. All five packages
have shipped, so:

- list all five (ai-sdk, ai-skills, ai-autopilot, ai-mcp, mcp) with
  correct versions, descriptions, and the dependency layering
- add the "which MCP package do I use" guidance so ai-mcp and mcp never
  read as duplicates
- point at examples/ and the changeset flow

Architecture.md: mark the family and @gemstack/mcp as shipped, drop the
"(later)" marker on mcp, and turn the suggested ship order into the
realized one.
@suleimansh suleimansh added the documentation Improvements or additions to documentation label Jun 26, 2026
@suleimansh suleimansh self-assigned this Jun 26, 2026
@suleimansh suleimansh merged commit a6ccc09 into main Jun 26, 2026
1 check passed
@suleimansh suleimansh deleted the docs/root-readme-architecture-freshen branch June 26, 2026 19:50
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant