JDSS/mem0
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clean up release highlights copy and removing emdash from the docs (#5984)

Browse Source
This commit is contained in:
Kartik
2026-06-29 21:27:53 +05:30
committed by GitHub
parent 754034abbc
commit b2ff3aeda5
73 changed files with 572 additions and 557 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/templates/api_reference_template.mdx
Vendored
+4 -4
View File
@@ -10,17 +10,17 @@ API reference pages document a single endpoint contract. Present metadata, reque
---
## ❌ DO NOT COPY — Guidance & Constraints
## ❌ DO NOT COPY: Guidance & Constraints
- Frontmatter must include `title`, `description`, `icon`, `method`, `path`. Heading should be `# METHOD /path`.
- Provide a quick facts table (Method, Path, Auth, Rate limit) followed by an `<Info>` block describing when to use the endpoint. Add `<Warning>` for beta headers or scope requirements.
- Requests require headers table, body/parameters table, and `<CodeGroup>` with cURL, Python, TypeScript. If a language is unavailable, include a `<Note>` explaining why.
- When migrating an existing endpoint page, keep the canonical examples and edge-case notes—drop them into these sections rather than inventing new payloads unless the API changed.
- When migrating an existing endpoint page, keep the canonical examples and edge-case notes. Drop them into these sections rather than inventing new payloads unless the API changed.
- Response section must show a canonical success payload, status-code table, and troubleshooting tips. Document pagination/idempotency in `<Tip>` or `<Note>` blocks.
- End with related endpoints, a sample workflow link, and two CTA cards (left = concept/feature, right = applied tutorial). Keep the comment reminder for reviewers.
---
## ✅ COPY THIS — Content Skeleton
## ✅ COPY THIS: Content Skeleton
````mdx
---
@@ -108,7 +108,7 @@ const response = await fetch("https://api.mem0.ai/v1/memories", {
| Status | Meaning | Fix |
| --- | --- | --- |
| `201` | Memory stored successfully. | — |
| `201` | Memory stored successfully. | N/A |
| `400` | Missing required field. | Provide `user_id` and `memory`. |
| `401` | Invalid or missing API key. | Refresh key in dashboard. |