docs(sdk): update SDK docs to describe v2 MemoryClient surface#6
Merged
docs(sdk): update SDK docs to describe v2 MemoryClient surface#6
Conversation
Rewrite the SDK section to describe the current public surface — MemoryClient, the providers config, and the slim ./browser entry — instead of the pre-split AtomicMemorySDK/ContextManager shape. - Overview, quickstart, architecture, provider-model, and all guides now use MemoryClient; userAccounts / platform / targetDomain examples are gone. - Scopes-and-identity drops UserAccountsManager and describes the Scope type the SDK actually accepts. - browser-helpers is now "Browser entry", describing the @atomicmemory/atomicmemory-sdk/browser subpath. - consent-and-gating and cookbook/knowledge-base are removed — those features live in the webapp wrapper, not the OSS core. - Storage / embeddings / api pages touched up for the same rename. Forward-only: these pages describe what the SDK is today, not a migration path from any prior shape.
…, ingestModes spelling - swapping-backends migration example now uses the real MemoryIngest shape (content/kind/metadata), not a non-existent memory field - quickstart multi-provider example uses pathPrefix (the real field), not apiStyle (webapp-wrapper-era) - ingestModes spelling: 'messages' plural matches types.ts - MemoryProvider.close() clarified — providers can define it but MemoryClient does not drive teardown
…ethods + requiredScope/extension-key shapes
- custom-provider example now implements the template-method hooks
(doIngest/doSearch/doGet/doDelete/doList) that BaseMemoryProvider
actually requires, not direct overrides of the public methods
- requiredScope shape corrected everywhere: { default: Array<keyof
Scope>, ingest?: ..., ... } not the old { user: bool, ... } form
- extension capability keys corrected to the real spellings: update,
forget, profile, reflect, batch (previously updater/forgetter/
profiler/reflector/batchOps — those are the TypeScript interface
names, not the capability keys)
- scopes-and-identity + capabilities + memory-provider + both backend
guides updated for consistency
…es call site Last two stale sdk. references: - errors.md handling example now uses memory.package(request) / memory.search(request) with the single-arg MemoryClient shape - atomicmemory-backend.md cache tip now says memory.capabilities()
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.
Summary
MemoryClient, theprovidersconfig, the./browsersubpath — instead of the pre-splitAtomicMemorySDK/ContextManagershape.concepts/consent-and-gatingandcookbook/knowledge-base(both belong to the proprietary webapp wrapper).browser-helpersas "Browser entry" and point it at@atomicmemory/atomicmemory-sdk/browser.Pages changed
sdk/overview.md,sdk/quickstart.mdsdk/concepts/architecture.md,provider-model.md,scopes-and-identity.md,storage-adapters.md,embeddings.mdsdk/guides/atomicmemory-backend.md,mem0-backend.md,custom-provider.md,browser-helpers.md,nodejs-server.md,browser-primitives.md,swapping-backends.mdsdk/api/overview.md,memory-provider.mdsidebars.ts(drops the two removed pages)Test plan
pnpm buildsucceeds — no broken internal links