Skip to content

Commit 9a0f366

Browse files
committed
docs: add entity context documentation and fix MDX parsing (supermemoryai#723)
Add entity context documentation to customization and add-memories pages, remove nav icons from Developer Platform, fix install.md parsing error Changes: - Remove icons from Developer Platform subheadings (Getting Started, Concepts, Using supermemory, Connectors and sync, Migration Guides) - Add Entity Context section to customization page with usage example and accordion for advanced API - Add entityContext parameter to add-memories Parameters table and examples accordion - Fix MDX parsing error in install.md (wrap curly braces in backticks)
1 parent 16da766 commit 9a0f366

4 files changed

Lines changed: 46 additions & 7 deletions

File tree

apps/docs/add-memories.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,7 @@ Upload PDFs, images, and documents directly.
199199
| `customId` | string | **Recommended.** Your ID for the content (conversation ID, doc ID). Enables updates and deduplication |
200200
| `containerTag` | string | Group by user/project. Required for user profiles |
201201
| `metadata` | object | Key-value pairs for filtering (strings, numbers, booleans) |
202+
| `entityContext` | string | Context for memory extraction on this container tag. Max 1500 chars. See [Customization](/concepts/customization#entity-context) |
202203

203204
<AccordionGroup>
204205
<Accordion title="Parameter Details & Examples">
@@ -257,6 +258,19 @@ Upload PDFs, images, and documents directly.
257258
```
258259
- No nested objects or arrays
259260
- Values: string, number, or boolean only
261+
262+
**Entity Context:**
263+
```typescript
264+
// Guide memory extraction for this container tag
265+
{
266+
containerTag: "session_abc123",
267+
entityContext: `Design exploration conversation between john@acme.com and Brand.ai assistant.
268+
Focus on John's design preferences and brand requirements.`
269+
}
270+
```
271+
- Max 1500 characters
272+
- Persists on the container tag
273+
- Combines with org-level filter prompts
260274
</Accordion>
261275
</AccordionGroup>
262276

apps/docs/concepts/customization.mdx

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,36 @@ await client.settings.update({
7272

7373
---
7474

75+
## Entity Context
76+
77+
Guide memory extraction for a specific container tag. Filter prompts are org-wide; entity context is per container.
78+
79+
```typescript
80+
await client.add({
81+
content: "User asked about logo variations for dark backgrounds...",
82+
containerTag: "session_abc123",
83+
entityContext: `Design exploration conversation between john@acme.com and Brand.ai assistant.
84+
Focus on John's design preferences and brand requirements.`
85+
});
86+
```
87+
88+
<Accordion title="Update entity context only">
89+
Update entity context for a container tag without uploading content.
90+
91+
```typescript
92+
await client.containerTags.update("session_abc123", {
93+
entityContext: `Design exploration conversation between john@acme.com and Brand.ai assistant.
94+
Focus on John's design preferences and brand requirements.`
95+
});
96+
```
97+
</Accordion>
98+
99+
<Note>
100+
Entity context persists on the container tag and combines with org-level filter prompts.
101+
</Note>
102+
103+
---
104+
75105
## Chunk Size
76106

77107
Control how documents are split into searchable pieces. Smaller chunks = more precise retrieval but less context per result.

apps/docs/docs.json

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,12 +69,10 @@
6969
"pages": [
7070
{
7171
"group": "Getting Started",
72-
"icon": "rocket",
7372
"pages": ["intro", "quickstart", "vibe-coding"]
7473
},
7574
{
7675
"group": "Concepts",
77-
"icon": "lightbulb",
7876
"pages": [
7977
"concepts/how-it-works",
8078
"concepts/graph-memory",
@@ -88,7 +86,6 @@
8886
},
8987
{
9088
"group": "Using supermemory",
91-
"icon": "brain",
9289
"pages": [
9390
"add-memories",
9491
"search",
@@ -103,7 +100,6 @@
103100
},
104101
{
105102
"group": "Connectors and sync",
106-
"icon": "plug",
107103
"pages": [
108104
"connectors/overview",
109105
{
@@ -125,7 +121,6 @@
125121
},
126122
{
127123
"group": "Migration Guides",
128-
"icon": "arrow-right-left",
129124
"pages": [
130125
{
131126
"group": "From another provider",

apps/docs/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ You can always reference the documentation by using the **SearchSupermemoryDocs
2828
- No → Just use search
2929

3030
5. How should I retrieve context?
31-
- OPTION A: One call with search included → profile({ containerTag, q: userMessage })
32-
- OPTION B: Separate calls → profile() for facts, search() for memories
31+
- OPTION A: One call with search included → `profile({ containerTag, q: userMessage })`
32+
- OPTION B: Separate calls → `profile()` for facts, `search()` for memories
3333

3434
## STEP 2: INSTALL
3535

0 commit comments

Comments
 (0)