docs: add SDK documentation as a peer section to Platform and API Reference#2
Merged
docs: add SDK documentation as a peer section to Platform and API Reference#2
Conversation
…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>
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
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.
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
MemoryProviderarchitecture 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
sdk/overview(with the deployment topologies diagram),sdk/quickstartMemoryProvidercontract, errors. Type-level signatures are deferred to the SDK's existingtypedocpipeline rather than hand-maintained here (prevents drift).loadKnowledgeBaseDiagrams (mermaid, via
@docusaurus/theme-mermaid){ results: [] }on blocked)getExtension<Packager>('package'))Cross-links (existing pages)
introduction.md: replaces "coming soon" with links to/sdk/overviewquickstart.md: adds a closing "Using the TypeScript SDK" sectionplatform/providers.md: disambiguation callout (embedding/LLM providers ≠ memory providers)platform/scope.md: see-also pointer to the SDK's client-side scope pagedocs/api-reference/sdk/coming-soon.mdremoved;@docusaurus/plugin-client-redirectsserves/api-reference/sdk/coming-soon→/sdk/overview(GitHub Pages compatible)Config
@docusaurus/theme-mermaid@3.10.0,@docusaurus/plugin-client-redirects@3.10.0docusaurus.config.ts: mermaid enabled, SDK navbar item inserted between Platform and API Reference, redirect plugin registered, footer updatedsidebars.ts: newsdkSidebar; coming-soon entry stripped fromapiReferenceSidebarOpen questions captured in the docs (not blockers)
npm install @atomicmemory/atomicmemory-sdk; verify before external users follow itMem0Providerpublic-support stance — the Mem0 guide carries a support-status notetypedocpipeline for generated reference — deferred follow-upTest plan
npm run buildpasses withonBrokenLinks: 'throw'build/sdk/**build/api-reference/sdk/coming-soon/index.htmluses meta refresh →/sdk/overviewnpm start: click through every SDK sidebar entry, confirm each of the 8 diagrams actually renders (mermaid hydrates client-side; worth eyeballing)🤖 Generated with Claude Code