Clean up release highlights copy and removing emdash from the docs (#5984)
This commit is contained in:
Vendored
+9
-9
@@ -10,24 +10,24 @@ Cookbooks are narrative tutorials. They start with a real problem, show the brok
|
||||
|
||||
---
|
||||
|
||||
## ❌ DO NOT COPY — Guidance & Constraints
|
||||
## ❌ DO NOT COPY: Guidance & Constraints
|
||||
- Tell a story: problem → broken demo → iterative fixes → production patterns.
|
||||
- Keep tone conversational; use real names ("Max", "Sarah"), not `user_123`.
|
||||
- Opening must stay tight: ≤2 short paragraphs (no bullet lists) before the first section.
|
||||
- Inline expected outputs immediately after each code block.
|
||||
- When modernizing an existing cookbook, keep the narrative beats, screenshots, and sample outputs—reshape them into this arc instead of rewriting unless the workflow changed.
|
||||
- When modernizing an existing cookbook, keep the narrative beats, screenshots, and sample outputs. Reshape them into this arc instead of rewriting unless the workflow changed.
|
||||
- Limit callouts to 3–5 per page. Prefer narrative text over stacked boxes.
|
||||
- Always provide Python **and** TypeScript tabs when an SDK exists for both.
|
||||
- Every page must end with exactly two navigation cards (left = related/side quest, right = next cookbook in the journey).
|
||||
|
||||
---
|
||||
|
||||
## ✅ COPY THIS — Content Skeleton
|
||||
## ✅ COPY THIS: Content Skeleton
|
||||
Paste the block below into a new cookbook, then replace all placeholders. Remove any section you don't need **only after** the happy path works.
|
||||
|
||||
```mdx
|
||||
---
|
||||
title: [Cookbook title — action oriented]
|
||||
title: [Cookbook title: action oriented]
|
||||
description: [1 sentence outcome]
|
||||
---
|
||||
|
||||
@@ -132,14 +132,14 @@ Call out the most common mistake or edge case for this layer.
|
||||
|
||||
## Production Patterns
|
||||
|
||||
- **[Pattern 1]** — `[When to use it]`
|
||||
- **[Pattern 1]**: `[When to use it]`
|
||||
```python
|
||||
# Example snippet
|
||||
```
|
||||
```typescript
|
||||
// Example snippet
|
||||
```
|
||||
- **[Pattern 2]** — `[When to use it]`
|
||||
- **[Pattern 2]**: `[When to use it]`
|
||||
```python
|
||||
# Example snippet
|
||||
```
|
||||
@@ -149,9 +149,9 @@ Call out the most common mistake or edge case for this layer.
|
||||
|
||||
## What You Built
|
||||
|
||||
- **[Capability 1]** — [How the cookbook delivers it]
|
||||
- **[Capability 2]** — [How the cookbook delivers it]
|
||||
- **[Capability 3]** — [How the cookbook delivers it]
|
||||
- **[Capability 1]**: [How the cookbook delivers it]
|
||||
- **[Capability 2]**: [How the cookbook delivers it]
|
||||
- **[Capability 3]**: [How the cookbook delivers it]
|
||||
|
||||
## Production Checklist
|
||||
|
||||
|
||||
Reference in New Issue
Block a user