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

[docs] platform core concept revamp and overview update (#3664)

Browse Source
This commit is contained in:
Parth Sharma
2025-10-26 15:15:13 +05:30
committed by GitHub
parent 61faf71064
commit 2c18355dd2
19 changed files with 595 additions and 318 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/templates/section_overview_template.mdx
Vendored
+30 -16
View File
@@ -13,7 +13,9 @@ Overview pages orient readers for an entire section. Summarize who it’s for, s
## ❌ DO NOT COPY — Guidance & Constraints
- Frontmatter must include `title`, `description`, `icon`. Keep the hero paragraph under two sentences describing audience + outcome.
- Provide an `<Info>` block pointing to the primary entry point (usually the quickstart). Use `<Warning>` only for major caveats (beta, deprecation).
- Card grids should list 4–6 journeys max using `<CardGroup cols={3}>` or `<Cards>`. Copy must stay ≤15 words, and every card needs an icon + link.
- Stage journeys in 4–6 cards total. Break into multiple `<CardGroup>` rows when a binary choice (e.g., Python vs Node) or stacked journeys reads better. Keep copy ≤15 words with icons + links.
- When migrating an existing overview, reuse the established journeys, images, and stats—reshape them into this layout rather than cutting content unless it’s outdated.
- Optional accordions (`<AccordionGroup>`) can tuck detailed tables (feature breakdowns, comparisons) beneath the hero when extra context is helpful.
- Optional visuals (comparison table, Mermaid diagram) should be left-to-right and only added when they reduce confusion.
- Finish with exactly two CTA cards: left = adjacent/alternative track, right = next logical step deeper in the section.
@@ -36,6 +38,15 @@ icon: "compass"
Start with [Quickstart link] if you’re new, then choose a deeper topic below.
</Info>
{/* Optional: delete if not needed */}
<AccordionGroup>
<Accordion title="[Optional value table]" icon="sparkles">
| Feature | Why it helps |
| --- | --- |
| ... | ... |
</Accordion>
</AccordionGroup>
{/* Optional: delete if not needed */}
```mermaid
graph LR
@@ -46,27 +57,30 @@ graph LR
## Choose your path
<CardGroup cols={3}>
<Card title="[Journey 1]" icon="rocket" href="/[link-1]">
{/* Use multiple rows if a 2-up decision helps */}
<CardGroup cols={2}>
<Card title="[Decision 1]" icon="rocket" href="/[link-1]">
[One-line outcome]
</Card>
<Card title="[Journey 2]" icon="brain" href="/[link-2]">
[One-line outcome]
</Card>
<Card title="[Journey 3]" icon="sparkles" href="/[link-3]">
[One-line outcome]
</Card>
<Card title="[Journey 4]" icon="book" href="/[link-4]">
[One-line outcome]
</Card>
<Card title="[Journey 5]" icon="life-ring" href="/[link-5]">
[One-line outcome]
</Card>
<Card title="[Journey 6]" icon="gear" href="/[link-6]">
<Card title="[Decision 2]" icon="brain" href="/[link-2]">
[One-line outcome]
</Card>
</CardGroup>
<CardGroup cols={3}>
<Card title="[Journey 1]" icon="sparkles" href="/[link-3]">
[One-line outcome]
</Card>
<Card title="[Journey 2]" icon="gear" href="/[link-4]">
[One-line outcome]
</Card>
<Card title="[Journey 3]" icon="book" href="/[link-5]">
[One-line outcome]
</Card>
</CardGroup>
{/* Duplicate another CardGroup (2 or 3 columns) if you need more coverage, but keep the total ≤6 cards. */}
<Tip>
[Optional cross-link, e.g., “Self-hosting? Jump to the OSS overview.”] Delete if unused.
</Tip>