vrr/supermemory
2
0
Fork 0
mirror of https://github.com/supermemoryai/supermemory.git synced 2026-05-02 21:50:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

update: Readme

Browse source
This commit is contained in:
Dhravya Shah 2025-09-13 22:09:40 -07:00
parent a17655460f
commit 90fd19f215
60 changed files with 41 additions and 3986 deletions
Download patch file Download diff file Expand all files Collapse all files

84
apps/docs/.cursor/rules/docs.mdc
View file

@ -1,84 +0,0 @@
---
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