Skip to content

docs: add SDK documentation as a peer section to Platform and API Reference#2

Merged
ethanj merged 1 commit intomainfrom
docs/sdk-documentation
Apr 20, 2026
Merged

docs: add SDK documentation as a peer section to Platform and API Reference#2
ethanj merged 1 commit intomainfrom
docs/sdk-documentation

Conversation

@ethanj
Copy link
Copy Markdown
Contributor

@ethanj ethanj commented Apr 20, 2026

Summary

Adds a dedicated SDK section to the docs site (docs.atomicmemory.ai) with equal navigational presence to Platform and API Reference. The SDK is framed as a platform utility agnostic to the memory backend — the pluggable MemoryProvider architecture is the headline, runtime capability inspection is the contract, and the site stays inside the public SDK surface (no internal consumption-architecture advice).

20 hand-authored pages, 8 mermaid diagrams (architecture + dataflow), and minimal cross-linking updates to existing Core pages.

What's in

  • Landing: sdk/overview (with the deployment topologies diagram), sdk/quickstart
  • Concepts (7): architecture, memory providers, capabilities, scopes and identity, storage adapters, embeddings, consent and gating
  • Guides (7): atomicmemory backend, mem0 backend, writing a custom provider, browser helpers, Node.js / server-side, browser primitives, swapping backends
  • API Reference (3 hand-written): reference overview, MemoryProvider contract, errors. Type-level signatures are deferred to the SDK's existing typedoc pipeline rather than hand-maintained here (prevents drift).
  • Cookbook (1): loadKnowledgeBase

Diagrams (mermaid, via @docusaurus/theme-mermaid)

  1. High-level SDK architecture (flowchart)
  2. Provider architecture (classDiagram)
  3. Ingest sequence
  4. Search with domain gating — matches actual contract ({ results: [] } on blocked)
  5. Package with extension probe — matches actual contract (getExtension<Packager>('package'))
  6. Storage subsystem
  7. Deployment topologies (four side-by-side shapes)
  8. Embeddings pipeline

Cross-links (existing pages)

  • introduction.md: replaces "coming soon" with links to /sdk/overview
  • quickstart.md: adds a closing "Using the TypeScript SDK" section
  • platform/providers.md: disambiguation callout (embedding/LLM providers ≠ memory providers)
  • platform/scope.md: see-also pointer to the SDK's client-side scope page
  • docs/api-reference/sdk/coming-soon.md removed; @docusaurus/plugin-client-redirects serves /api-reference/sdk/coming-soon/sdk/overview (GitHub Pages compatible)

Config

  • New deps: @docusaurus/theme-mermaid@3.10.0, @docusaurus/plugin-client-redirects@3.10.0
  • docusaurus.config.ts: mermaid enabled, SDK navbar item inserted between Platform and API Reference, redirect plugin registered, footer updated
  • sidebars.ts: new sdkSidebar; coming-soon entry stripped from apiReferenceSidebar

Open questions captured in the docs (not blockers)

  • SDK publish status on npm — Quickstart uses npm install @atomicmemory/atomicmemory-sdk; verify before external users follow it
  • Mem0Provider public-support stance — the Mem0 guide carries a support-status note
  • Cross-repo typedoc pipeline for generated reference — deferred follow-up

Test plan

  • npm run build passes with onBrokenLinks: 'throw'
  • All 20 SDK pages render to build/sdk/**
  • All 8 mermaid diagram sources compiled into JS bundles (spot-checked D3, D5, D7)
  • Redirect stub at build/api-reference/sdk/coming-soon/index.html uses meta refresh → /sdk/overview
  • Navbar order: Platform | SDK | API Reference | GitHub
  • Visual smoke test on npm start: click through every SDK sidebar entry, confirm each of the 8 diagrams actually renders (mermaid hydrates client-side; worth eyeballing)
  • Mobile responsive pass on mermaid diagrams
  • GitHub Pages deploy confirmed on docs.atomicmemory.ai

🤖 Generated with Claude Code

…erence

Introduces a dedicated SDK documentation section (20 hand-authored pages)
with equal navigational presence to Platform and API Reference. The SDK is
framed as a platform utility agnostic to the memory backend — the provider
model is the headline, runtime capability inspection is the contract.

Structure: overview + quickstart, 7 concept pages (architecture, provider
model, capabilities, scopes and identity, storage adapters, embeddings,
consent and gating), 7 guides (atomicmemory backend, mem0 backend, custom
provider, browser helpers, Node.js server, browser primitives, swapping
backends), 3 API reference contract pages (reference overview, MemoryProvider
contract, errors), and a cookbook entry for loadKnowledgeBase.

Architecture and dataflow diagrams are rendered via @docusaurus/theme-mermaid:
high-level SDK architecture, provider classDiagram, ingest sequence, search
with domain gating, package with extension probe, storage subsystem,
deployment topologies, and the embeddings pipeline. Every diagram is tied
to real class/file/method names from the SDK source.

Type-level API reference (method signatures, exported types, subpath exports)
is deferred to the SDK's existing typedoc pipeline; hand-written pages here
cover only the authoring contracts that generated docs cannot.

Also:
- Replaces "coming soon" text in introduction.md with links to /sdk/overview
- Adds an "Using the TypeScript SDK" section to the Core quickstart
- Adds memory-provider disambiguation to platform/providers.md
- Adds a see-also pointer to platform/scope.md
- Deletes docs/api-reference/sdk/coming-soon.md, replaced by a
  @docusaurus/plugin-client-redirects redirect (/api-reference/sdk/coming-soon
  -> /sdk/overview) — GitHub Pages compatible, unlike _redirects

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@ethanj ethanj merged commit eef7555 into main Apr 20, 2026
@ethanj ethanj deleted the docs/sdk-documentation branch April 20, 2026 06:11
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