supermemory/apps/docs
Aswin-Ram-K c6fd728981 docs(api): add V3/V4 to V5 migration guide
## What and why

Add an agent-oriented V3/V4 to V5 migration guide covering document
ingestion and updates, content management, search, profiles, memory
forgetting, namespaces, organization settings, typed filters, and
rollout verification. Shared snippets keep the comprehensive guide and
the focused topic pages consistent, following the existing
`/snippets/*.mdx` import convention used elsewhere in the docs.

```mermaid
flowchart LR
  Legacy[Legacy integration inventory] --> Mapping[Domain migration guidance]
  Mapping --> V5[V5 requests and response readers]
  V5 --> Verify[Side-by-side verification and rollout]
```

## Grounding

Every old-vs-new claim traces to code in this repository:

- `packages/validation/api.ts` - `SearchRequestSchema`,
  `Searchv4RequestSchema`, `ListMemoriesQuerySchema`,
  `MemoryUpdateSchema`, `BulkDeleteMemoriesSchema`,
  `ContainerTagListTypeSchema`, `SearchFiltersSchema`.
- `packages/validation/schemas.ts` - `MemoryEntrySchema`,
  `OrganizationSettingsSchema`, `MemoryRelationEnum`.
- `packages/tools/src/shared/memory-client.ts` and
  `packages/tools/src/shared/types.ts` - the `/v4/profile` request and
  `profile.static` / `profile.dynamic` / `profile.buckets` reader.
- `apps/mcp/src/server/client/index.ts` - live `/v3/container-tags/list`,
  `/v4/memories/list`, and `/v3/documents/file` call sites.

## Notable findings documented

- `SearchFiltersSchema` is `z.array(z.unknown())` behind a
  `// TODO: Improve filter schema` comment, so legacy conditions were
  never validated at the edge. The typed-filter page documents the
  mechanical conversion and calls out the numeric-string-to-JSON-number
  trap that a straight rename would miss.
- `OrganizationSettingsSchema` carries connector credentials that are
  absent from the public V5 `/organization` response; the page warns
  against reading them from `GET /v3/settings`.
- Operations with no V5 replacement are listed explicitly rather than
  given invented substitutes.

## Validation

- `docs.json` parses as JSON; all 11 new nav entries resolve to authored
  pages, and every pre-existing nav entry still resolves.
- All 12 snippet imports and every relative/absolute link across the 23
  new files resolve to real targets.
- Fences, braces, and JSX component tags balance across all new files;
  frontmatter parses as YAML.
- `git diff --check` passes.

## Impact

Documentation only. No runtime, schema, or SDK behavior changes.
2026-09-23 03:18:51 -05:00
..
.cursor/rules migrate docs to public 2025-09-28 16:42:06 -07:00
api-reference docs: restructure documentation site and update integration UI (#1331) 2026-07-21 20:19:30 -07:00
concepts docs: fixed typo in graph-memory.mdx (#1640) 2026-09-02 10:07:03 -07:00
connectors Align billing and Gmail docs with current plan entitlements (#1685) 2026-09-18 22:01:05 +00:00
images Add Muse Code plugin docs (#1674) 2026-09-17 09:36:04 -07:00
ingestion docs: historical backfill guide (#1474) 2026-08-14 20:46:21 +00:00
integrations Add Muse Code plugin docs (#1674) 2026-09-17 09:36:04 -07:00
logo migrate docs to public 2025-09-28 16:42:06 -07:00
memorybench docs: restructure documentation site and update integration UI (#1331) 2026-07-21 20:19:30 -07:00
migration docs(api): add V3/V4 to V5 migration guide 2026-09-23 03:18:51 -05:00
overview Align billing and Gmail docs with current plan entitlements (#1685) 2026-09-18 22:01:05 +00:00
recall docs(memories): forget-matching accepts an id list (bound preview→apply) (#1367) 2026-08-06 09:32:32 +00:00
self-hosting Add Muse Code plugin docs (#1674) 2026-09-17 09:36:04 -07:00
smfs docs: SMFS documentation — providers, Python bash tool, examples (#889) 2026-04-28 20:04:15 -07:00
snippets docs(api): add V3/V4 to V5 migration guide 2026-09-23 03:18:51 -05:00
supermemory-mcp feat(mcp): add get_profile and use snake_case for public tools (#1665) 2026-09-16 23:37:34 -07:00
user-profiles docs: restructure documentation site and update integration UI (#1331) 2026-07-21 20:19:30 -07:00
videos add eve docs and refresh integrations (#1671) 2026-09-16 15:24:08 -07:00
.gitignore migrate docs to public 2025-09-28 16:42:06 -07:00
agents-and-mcp.mdx docs: restructure documentation site and update integration UI (#1331) 2026-07-21 20:19:30 -07:00
authentication.mdx docs: restructure documentation site and update integration UI (#1331) 2026-07-21 20:19:30 -07:00
docs.json docs(api): add V3/V4 to V5 migration guide 2026-09-23 03:18:51 -05:00
favicon.png migrate docs to public 2025-09-28 16:42:06 -07:00
index.mdx chore(web): reduce the app to a redirect shell, drop the browser extension (#1651) 2026-09-07 19:56:46 +00:00
install.md docs: align vibe-coding prompt + install guide with canonical API (#976) 2026-05-19 15:27:20 -07:00
package.json use portless 2026-05-06 22:42:34 -07:00
quickstart.mdx chore(web): reduce the app to a redirect shell, drop the browser extension (#1651) 2026-09-07 19:56:46 +00:00
README.md migrate docs to public 2025-09-28 16:42:06 -07:00
style.css add eve docs and refresh integrations (#1671) 2026-09-16 15:24:08 -07:00
test.py docs changes (#678) 2026-01-18 16:55:32 -08:00
test.ts mastra integration (#717) 2026-02-03 00:43:08 +00:00
using-supermemory.mdx docs: historical backfill guide (#1474) 2026-08-14 20:46:21 +00:00

supermemory Docs