my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

#1	---
#2	title: Section Overview Template
#3	description: "Blueprint for landing pages with headline, card grid, and CTAs."
#4	icon: "grid"
#5	---
#6
#7	# Section Overview Template
#8
#9	Overview pages orient readers for an entire section. Summarize who it’s for, surface the core journeys, and end with a clear “build vs explore” CTA pair.
#10
#11	---
#12
#13	## ❌ DO NOT COPY — Guidance & Constraints
#14	- Frontmatter must include `title`, `description`, `icon`. Keep the hero paragraph under two sentences describing audience + outcome.
#15	- Provide an `<Info>` block pointing to the primary entry point (usually the quickstart). Use `<Warning>` only for major caveats (beta, deprecation).
#16	- 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.
#17	- 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.
#18	- Optional accordions (`<AccordionGroup>`) can tuck detailed tables (feature breakdowns, comparisons) beneath the hero when extra context is helpful.
#19	- Optional visuals (comparison table, Mermaid diagram) should be left-to-right and only added when they reduce confusion.
#20	- Finish with exactly two CTA cards: left = adjacent/alternative track, right = next logical step deeper in the section.
#21
#22	---
#23
#24	## ✅ COPY THIS — Content Skeleton
#25
#26	````mdx
#27	---
#28	title: [Section name] Overview
#29	description: [30-second summary of what lives in this section]
#30	icon: "compass"
#31	---
#32
#33	# [Section] Overview
#34
#35	[State who this section is for.] [Explain what they’ll accomplish after browsing these docs.]
#36
#37	<Info>
#38	Start with [Quickstart link] if you’re new, then choose a deeper topic below.
#39	</Info>
#40
#41	{/* Optional: delete if not needed */}
#42	<AccordionGroup>
#43	<Accordion title="[Optional value table]" icon="sparkles">
#44	\| Feature \| Why it helps \|
#45	\| --- \| --- \|
#46	\| ... \| ... \|
#47	</Accordion>
#48	</AccordionGroup>
#49
#50	{/* Optional: delete if not needed */}
#51	```mermaid
#52	graph LR
#53	A[Get set up] */} B[Learn concepts]
#54	B */} C[Build workflows]
#55	C */} D[Support & scale]
#56	```
#57
#58	## Choose your path
#59
#60	{/* Use multiple rows if a 2-up decision helps */}
#61	<CardGroup cols={2}>
#62	<Card title="[Decision 1]" icon="rocket" href="/[link-1]">
#63	[One-line outcome]
#64	</Card>
#65	<Card title="[Decision 2]" icon="brain" href="/[link-2]">
#66	[One-line outcome]
#67	</Card>
#68	</CardGroup>
#69
#70	<CardGroup cols={3}>
#71	<Card title="[Journey 1]" icon="sparkles" href="/[link-3]">
#72	[One-line outcome]
#73	</Card>
#74	<Card title="[Journey 2]" icon="gear" href="/[link-4]">
#75	[One-line outcome]
#76	</Card>
#77	<Card title="[Journey 3]" icon="book" href="/[link-5]">
#78	[One-line outcome]
#79	</Card>
#80	</CardGroup>
#81
#82	{/* Duplicate another CardGroup (2 or 3 columns) if you need more coverage, but keep the total ≤6 cards. */}
#83
#84	<Tip>
#85	[Optional cross-link, e.g., “Self-hosting? Jump to the OSS overview.”] Delete if unused.
#86	</Tip>
#87
#88	## Keep going
#89
#90	{/* DEBUG: verify CTA targets */}
#91
#92	<CardGroup cols={2}>
#93	<Card
#94	title="[Alternative or adjacent track]"
#95	description="[Why it might be the better next step]"
#96	icon="arrows-left-right"
#97	href="/[alternate-link]"
#98	/>
#99	<Card
#100	title="[Next deep dive]"
#101	description="[What they’ll build or learn next]"
#102	icon="rocket"
#103	href="/[next-link]"
#104	/>
#105	</CardGroup>
#106	````
#107
#108	---
#109
#110	## ✅ Publish Checklist
#111	- [ ] Hero paragraph states audience + outcome; `<Info>` points to the primary entry point.
#112	- [ ] Card grid lists 4–6 journeys with concise copy and valid icons/links.
#113	- [ ] Optional visuals (tables/Mermaid) are LR and actually clarify the flow.
#114	- [ ] CTA pair present with related alternative on the left and next logical step on the right.
#115	- [ ] All placeholders and unused callouts removed before publishing.
#116
#117	## Browse Other Templates
#118
#119	<CardGroup cols={3}>
#120	<Card
#121	title="Quickstart"
#122	description="Install → Configure → Add → Search → Delete."
#123	icon="rocket"
#124	href="/templates/quickstart_template"
#125	/>
#126	<Card
#127	title="Operation Guide"
#128	description="Single task walkthrough with verification checkpoints."
#129	icon="circle-check"
#130	href="/templates/operation_guide_template"
#131	/>
#132	<Card
#133	title="Feature Guide"
#134	description="Explain when and why to use a capability, not just the API."
#135	icon="sparkles"
#136	href="/templates/feature_guide_template"
#137	/>
#138	<Card
#139	title="Concept Guide"
#140	description="Define mental models, key terms, and diagrams."
#141	icon="brain"
#142	href="/templates/concept_guide_template"
#143	/>
#144	<Card
#145	title="Integration Guide"
#146	description="Configure Mem0 alongside third-party tools."
#147	icon="plug"
#148	href="/templates/integration_guide_template"
#149	/>
#150	<Card
#151	title="Cookbook"
#152	description="Narrative, end-to-end walkthroughs."
#153	icon="book-open"
#154	href="/templates/cookbook_template"
#155	/>
#156	<Card
#157	title="API Reference"
#158	description="Endpoint specifics with dual-language examples."
#159	icon="code"
#160	href="/templates/api_reference_template"
#161	/>
#162	<Card
#163	title="Parameters Reference"
#164	description="Accepted fields, defaults, and misuse fixes."
#165	icon="list"
#166	href="/templates/parameters_reference_template"
#167	/>
#168	<Card
#169	title="Migration Guide"
#170	description="Plan → migrate → validate with rollback."
#171	icon="arrow-right"
#172	href="/templates/migration_guide_template"
#173	/>
#174	<Card
#175	title="Release Notes"
#176	description="Ship highlights and required CTAs."
#177	icon="megaphone"
#178	href="/templates/release_notes_template"
#179	/>
#180	<Card
#181	title="Troubleshooting Playbook"
#182	description="Symptom → diagnose → fix."
#183	icon="life-buoy"
#184	href="/templates/troubleshooting_playbook_template"
#185	/>
#186	<Card
#187	title="Section Overview"
#188	description="Landing pages with card grids and CTA pair."
#189	icon="grid"
#190	href="/templates/section_overview_template"
#191	/>
#192	</CardGroup>
#193
#194	<CardGroup cols={2}>
#195	<Card
#196	title="Contribution Hub"
#197	description="Review the authoring workflow and linked templates."
#198	icon="clipboard-list"
#199	href="/platform/contribute"
#200	/>
#201	<Card
#202	title="Docs Home"
#203	description="Return to the platform overview once you’re done."
#204	icon="compass"
#205	href="/platform/overview"
#206	/>
#207	</CardGroup>
#208

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public