[docs] platform core concept revamp and overview update (#3664)
This commit is contained in:
+1
@@ -14,6 +14,7 @@ Concept guides establish a shared mental model before feature or API docs. Defin
|
||||
- Frontmatter must include `title`, `description`, `icon`. Lead with a definition + analogy in two sentences max.
|
||||
- Add an `<Info>` block (“Why it matters”) with 2–3 bullets summarizing user impact. Use `<Warning>` near limitations or beta callouts.
|
||||
- Introduce vocabulary via `## Key terms` (table or bullets) before diving deeper.
|
||||
- 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.
|
||||
- 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`).
|
||||
- Include at least one light code/JSON snippet or data table so the concept ties back to implementation.
|
||||
- Close with a “Put it into practice” checklist, “See it live” links, and the standard two-card CTA (left = feature/reference, right = applied cookbook).
|
||||
|
||||
Reference in New Issue
Block a user