docs: stand up the GemStack documentation site (VitePress)#58
Merged
Conversation
GemStack had no documentation home of its own: each package shipped only a short README, and the deep narrative docs for this engine still lived in the Rudder repo, framed around the old @rudderjs/ai and @rudderjs/mcp scope. This adds a VitePress site under docs/ that owns the framework-agnostic engine documentation: - Landing page, guide (what is GemStack, installation, first agent), and a packages overview. - Per-package deep guides: ai-sdk split into agents, tools, streaming, structured output, memory, RAG, providers, and testing/evals; plus ai-skills, ai-autopilot, ai-mcp, and the standalone mcp server framework. All content is migrated and neutralized: @gemstack scope throughout, only documents what the @gemstack packages actually export, and drops every Rudder binding (ORM-backed stores, the /server provider, make:agent / ai:eval CLI), noting they live in @rudderjs/ai. Several inaccuracies carried over from the old Rudder docs were corrected against source (stopWhen is not an agent() config key; run stores require a caller-supplied CacheAdapter; queue/broadcast go through the neutral configureAiQueue seam). docs:build is green with no dead links. Refs #57
suleimansh
added
documentation
This was referenced Jun 27, 2026
docs(ai,mcp): re-point engine docs to GemStack, keep the Rudder binding surface
rudderjs/rudder#1464
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #57.
What
GemStack had no documentation home of its own. Each package shipped only a short README, and the deep narrative docs for this engine still lived in the rudder repo (
docs/guide/ai.md, 1090 lines;docs/guide/mcp.md, 229 lines), framed around the old@rudderjs/ai/@rudderjs/mcpscope.This PR adds a VitePress site under
docs/(the stack GemStack already knows from rudder, deployable togemstack.land) that owns the framework-agnostic engine documentation.Structure
ai-sdksplit into deep guides: Overview, Agents, Tools, Streaming, Structured Output, Memory & Persistence, Vector Stores & RAG, Providers, Testing & Evals.ai-skills,ai-autopilot,ai-mcp, and the standalonemcpserver framework, each its own page.Migration and neutralization
All content is migrated from rudder's docs and neutralized:
@gemstack/*scope throughout; nothing presents@rudderjs/*as a current API.@gemstackpackages actually export (every symbol verified against source)./serverprovider,make:agent/ai:evalCLI, doctor/Telescope), noting they live in@rudderjs/ai.AiRegistry.register(...)+setDefault(...)), not the rudderconfig/ai.tsconvention.Several inaccuracies that had been sitting in the old rudder docs were corrected against source along the way:
stopWhenis not anagent({ ... })config key (it is anAgentsubclass override).CacheAdapter, not a framework-bound store.configureAiQueueseam.EmbeddingUserMemoryis JSDoc-only (not exported), so it is documented as aUserMemoryimplementation pattern rather than a shipped class.Verification
pnpm --filter @gemstack/docs docs:buildis green with no dead links. The@gemstack/docsworkspace package is private and not published; no changeset needed.Follow-up
A separate rudder PR will trim
ai.md/mcp.mdto the binding surface and link out to this site.