Rewriting the cookbook introduction to update it and make it more user friendly. #2082
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TL;DR: Rewrites the Cookbook introduction for clarity and usability. Adds quick-start Python/JS examples, streaming demo, glossary, and practical guidance on knobs, limits, and best practices.
Summary
This PR rewrites the Cookbook introduction to make it more user-friendly, actionable, and code-first.
The previous version gave a high-level overview but lacked copy-pasteable examples and practical guidance.
This rewrite focuses on the “developer experience” by giving readers immediate, working snippets and clear mental models.
What’s Changed
Why This Helps
Notes for Reviewers
✅ Clearer, friendlier, and more actionable for first-time Cookbook readers.
For new content
When contributing new content, read through our contribution guidelines, and mark the following action items as completed:
We will rate each of these areas on a scale from 1 to 4, and will only accept contributions that score 3 or higher on all areas. Refer to our contribution guidelines for more details.