Clean up release highlights copy and removing emdash from the docs (#5984)
This commit is contained in:
+5
-5
@@ -10,28 +10,28 @@ Quickstarts are the fastest path to first success. Each page should configure th
|
||||
|
||||
---
|
||||
|
||||
## ❌ DO NOT COPY — Guidance & Constraints
|
||||
## ❌ DO NOT COPY: Guidance & Constraints
|
||||
- Keep the intro tight: one-sentence promise + `<Info>` prerequisites. Add `<Warning>` only for blocking requirements (e.g., “requires paid tier”).
|
||||
- Default to Python + TypeScript examples inside `<Tabs>` with `<Steps>` per language. If a second language truly doesn’t exist, add a `<Note>` explaining why.
|
||||
- Every journey must follow **Install → Configure → Add → Search → Delete** (or closest equivalents). Drop verification `<Info icon="check">` immediately after the critical operation.
|
||||
- When migrating an existing quickstart, reuse canonical snippets and screenshots—reshape them into this flow rather than rewriting content unless the product changed.
|
||||
- When migrating an existing quickstart, reuse canonical snippets and screenshots. Reshape them into this flow rather than rewriting content unless the product changed.
|
||||
- If you include a Mermaid diagram, keep it optional and render left-to-right (`graph LR`) so it doesn’t flood the page.
|
||||
- End with exactly two CTA cards: left = related/alternative path, right = next step in the journey. No link farms.
|
||||
|
||||
---
|
||||
|
||||
## ✅ COPY THIS — Content Skeleton
|
||||
## ✅ COPY THIS: Content Skeleton
|
||||
Paste the block below into a new quickstart, then replace **every** placeholder. Remove optional sections only after the happy path is working.
|
||||
|
||||
````mdx
|
||||
---
|
||||
title: [Quickstart title — action focused]
|
||||
title: [Quickstart title: action focused]
|
||||
description: [1 sentence outcome]
|
||||
icon: "rocket"
|
||||
estimatedTime: "[~X minutes]"
|
||||
---
|
||||
|
||||
# [Hero headline — promise the win]
|
||||
# [Hero headline: promise the win]
|
||||
|
||||
<Info>
|
||||
**Prerequisites**
|
||||
|
||||
Reference in New Issue
Block a user