my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

#1	---
#2	title: Concept Guide Template
#3	description: "Teach mental models and terminology before diving into implementation."
#4	icon: "brain"
#5	---
#6
#7	# Concept Guide Template
#8
#9	Concept guides establish a shared mental model before feature or API docs. Define the idea, show how it behaves over time, and point to practical follow-ups.
#10
#11	---
#12
#13	## ❌ DO NOT COPY — Guidance & Constraints
#14	- Frontmatter must include `title`, `description`, `icon`. Lead with a definition + analogy in two sentences max.
#15	- Add an `<Info>` block (“Why it matters”) with 2–3 bullets summarizing user impact. Use `<Warning>` near limitations or beta callouts.
#16	- Introduce vocabulary via `## Key terms` (table or bullets) before diving deeper.
#17	- When migrating legacy pages, preserve canonical distinctions (e.g., short-term vs long-term) and fold them into the template rather than replacing them with new frameworks.
#18	- Organize the body with question-style headings (`How does it work?`, `When should you use it?`, `How it compares`). Optional diagrams should be left-to-right (`graph LR`).
#19	- Include at least one light code/JSON snippet or data table so the concept ties back to implementation.
#20	- Close with a “Put it into practice” checklist, “See it live” links, and the standard two-card CTA (left = feature/reference, right = applied cookbook).
#21
#22	---
#23
#24	## ✅ COPY THIS — Content Skeleton
#25
#26	````mdx
#27	---
#28	title: [Concept name]
#29	description: [One-sentence promise of understanding]
#30	icon: "lightbulb"
#31	---
#32
#33	# [Concept headline]
#34
#35	[Define the concept in one sentence.] [Add an analogy or context hook.]
#36
#37	<Info>
#38	Why it matters
#39	- [Impact bullet]
#40	- [Impact bullet]
#41	- [Impact bullet]
#42	</Info>
#43
#44	## Key terms
#45
#46	- [Term] – [Short definition]
#47	- [Term] – [Short definition]
#48
#49	{/* Optional: delete if not needed */}
#50	```mermaid
#51	graph LR
#52	A[Input] */} B[Concept]
#53	B */} C[Outcome]
#54	```
#55
#56	## How does it work?
#57
#58	[Explain lifecycle or architecture.]
#59
#60	```python
#61	# Minimal snippet that anchors the concept in code
#62	```
#63
#64	<Tip>
#65	[Nuance or best practice related to this concept.]
#66	</Tip>
#67
#68	## When should you use it?
#69
#70	- [Scenario 1]
#71	- [Scenario 2]
#72	- [Scenario 3]
#73
#74	## How it compares
#75
#76	\| Option \| Best for \| Trade-offs \|
#77	\| --- \| --- \| --- \|
#78	\| [Concept] \| [Use case] \| [Caveat] \|
#79	\| [Alternative] \| [Use case] \| [Caveat] \|
#80
#81	<Warning>
#82	[Optional limitation or beta note.] Delete if not needed.
#83	</Warning>
#84
#85	## Put it into practice
#86
#87	- [Operation or feature doc that relies on this concept]
#88	- [Another supporting doc]
#89
#90	## See it live
#91
#92	- [Cookbook or integration demonstrating the concept]
#93	- [Recording, demo, or sample repo]
#94
#95	{/* DEBUG: verify CTA targets */}
#96
#97	<CardGroup cols={2}>
#98	<Card
#99	title="[Feature or reference]"
#100	description="[Why this deep dive matters]"
#101	icon="book"
#102	href="/[feature-link]"
#103	/>
#104	<Card
#105	title="[Applied cookbook]"
#106	description="[What they’ll build next]"
#107	icon="rocket"
#108	href="/[cookbook-link]"
#109	/>
#110	</CardGroup>
#111	````
#112
#113	---
#114
#115	## ✅ Publish Checklist
#116	- [ ] Definition + analogy stay within two sentences.
#117	- [ ] “Why it matters” bullets focus on user impact, not implementation detail.
#118	- [ ] Key terms, lifecycle explanation, and comparison table are present (or intentionally removed when irrelevant).
#119	- [ ] At least one code/JSON/table example grounds the concept.
#120	- [ ] CTA pair links to a feature/reference (left) and applied tutorial (right).
#121
#122	## Browse Other Templates
#123
#124	<CardGroup cols={3}>
#125	<Card
#126	title="Quickstart"
#127	description="Install → Configure → Add → Search → Delete."
#128	icon="rocket"
#129	href="/templates/quickstart_template"
#130	/>
#131	<Card
#132	title="Operation Guide"
#133	description="Single task walkthrough with verification checkpoints."
#134	icon="circle-check"
#135	href="/templates/operation_guide_template"
#136	/>
#137	<Card
#138	title="Feature Guide"
#139	description="Explain when and why to use a capability, not just the API."
#140	icon="sparkles"
#141	href="/templates/feature_guide_template"
#142	/>
#143	<Card
#144	title="Concept Guide"
#145	description="Define mental models, key terms, and diagrams."
#146	icon="brain"
#147	href="/templates/concept_guide_template"
#148	/>
#149	<Card
#150	title="Integration Guide"
#151	description="Configure Mem0 alongside third-party tools."
#152	icon="plug"
#153	href="/templates/integration_guide_template"
#154	/>
#155	<Card
#156	title="Cookbook"
#157	description="Narrative, end-to-end walkthroughs."
#158	icon="book-open"
#159	href="/templates/cookbook_template"
#160	/>
#161	<Card
#162	title="API Reference"
#163	description="Endpoint specifics with dual-language examples."
#164	icon="code"
#165	href="/templates/api_reference_template"
#166	/>
#167	<Card
#168	title="Parameters Reference"
#169	description="Accepted fields, defaults, and misuse fixes."
#170	icon="list"
#171	href="/templates/parameters_reference_template"
#172	/>
#173	<Card
#174	title="Migration Guide"
#175	description="Plan → migrate → validate with rollback."
#176	icon="arrow-right"
#177	href="/templates/migration_guide_template"
#178	/>
#179	<Card
#180	title="Release Notes"
#181	description="Ship highlights and required CTAs."
#182	icon="megaphone"
#183	href="/templates/release_notes_template"
#184	/>
#185	<Card
#186	title="Troubleshooting Playbook"
#187	description="Symptom → diagnose → fix."
#188	icon="life-buoy"
#189	href="/templates/troubleshooting_playbook_template"
#190	/>
#191	<Card
#192	title="Section Overview"
#193	description="Landing pages with card grids and CTA pair."
#194	icon="grid"
#195	href="/templates/section_overview_template"
#196	/>
#197	</CardGroup>
#198
#199	<CardGroup cols={2}>
#200	<Card
#201	title="Contribution Hub"
#202	description="Review the authoring workflow and linked templates."
#203	icon="clipboard-list"
#204	href="/platform/contribute"
#205	/>
#206	<Card
#207	title="Docs Home"
#208	description="Return to the platform overview once you’re done."
#209	icon="compass"
#210	href="/platform/overview"
#211	/>
#212	</CardGroup>
#213

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public