blob: 6c2516e23d4a76c2746d3304d0d0db1734b08287 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
|
---
description:
globs:
alwaysApply: true
---
# Documentation MDX Format
All documentation files use MDX format with a specific structure:
## Frontmatter
Every documentation file must begin with frontmatter:
```mdx
---
title: "Page Title"
description: "Brief description of the page content"
icon: "icon-name" # Optional, uses Lucide icons
sidebarTitle: "Optional Sidebar Title" # Optional
---
```
Example: @features/query-rewriting.mdx
## Components
Use the following components to enhance documentation:
### Accordion
For collapsible sections:
```mdx
<Accordion title="Section Title" defaultOpen icon="sparkles">
Content goes here...
</Accordion>
```
Example: @creation/supported-types.mdx
### Notes and Warnings
For important information:
```mdx
<Note>
Important information goes here.
</Note>
<Warning>
Critical warning goes here.
</Warning>
```
Example: @creation/adding-memories.mdx
### Code Examples
For multi-language code examples:
```mdx
<CodeGroup>
```bash cURL
curl https://api.supermemory.ai/v3/endpoint \
--header 'Authorization: Bearer SUPERMEMORY_API_KEY'
```
```typescript Typescript
await client.method({
parameter: "value"
})
```
```python Python
client.method(
parameter="value"
)
```
</CodeGroup>
```
Example: @essentials/authentication.mdx
|