[docs] platform core concept revamp and overview update (#3664)
This commit is contained in:
+1
@@ -15,6 +15,7 @@ Operation guides focus on a single action (add, search, update, delete). Show th
|
||||
- Lead with a two-sentence promise (problem → outcome), followed by an `<Info>` prerequisites block and optional `<Warning>` for hazards (overwrites, rate limits).
|
||||
- Include a “When to pick this” bullet list (≤3 items) so readers confirm they’re in the right doc.
|
||||
- Use Tabs with Python and TypeScript examples. If only one SDK exists, add a `<Note>` stating that explicitly.
|
||||
- When migrating legacy guides, keep existing code paths and notes—slot them into these sections instead of replacing them unless behavior changed.
|
||||
- Provide `<Info icon="check">` verification after each critical step; call out the most common error with a `<Warning>` close to where it can occur.
|
||||
- End with exactly two CTA cards: left = conceptual depth, right = applied example/cookbook.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user