-
-
Notifications
You must be signed in to change notification settings - Fork 2
docs: Update Recipes documentation #71
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR restructures the Recipes API documentation from a single monolithic file into a well-organized multi-page documentation section. The content has been significantly expanded with clearer explanations, modernized code examples, and comprehensive coverage of recipe functionality.
Key changes include:
- Splitting documentation into three focused pages: Overview, Runtime, and Class Generation
- Removing the "under development" warning to indicate production readiness
- Adding detailed explanations of class naming conventions and generation mechanics
- Expanding FAQ sections with practical comparisons to similar libraries (CVA, Panda CSS, Stitches)
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
apps/docs/content/docs/02.api/10.recipes.md |
Original monolithic recipes documentation file removed |
apps/docs/content/docs/02.api/10.recipes/00.index.md |
New overview page introducing recipes concept, defining recipes, variants, default variants, compound variants, and best practices |
apps/docs/content/docs/02.api/10.recipes/01.runtime.md |
New runtime documentation explaining how to use recipes in components, runtime resolution, and type safety |
apps/docs/content/docs/02.api/10.recipes/02.class-generation.md |
New class generation documentation detailing how recipe fields connect to utilities, class naming conventions, and CSS output |
apps/docs/content/docs/02.api/10.recipes/.navigation.yml |
Navigation metadata file defining section title and icon for the Recipes documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This pull request restructures and significantly expands the documentation for the "Recipes" API in Styleframe. The single, large markdown file has been split into a new overview page and navigation metadata, with improved organization, clearer examples, and more comprehensive explanations of recipes, their options, and best practices.
Documentation Restructuring and Improvements:
10.recipes.mdfile has been removed and replaced with a more modular structure, including a new overview page (00.index.md) and navigation metadata (.navigation.yml). [1] [2] [3]New and Expanded Content:
00.index.mdprovides a clearer introduction to recipes, step-by-step examples of defining recipes, and detailed explanations of recipe options, variants, default variants, and compound variants.Navigation and Metadata Updates:
.navigation.ymlfor better organization and consistency with the rest of the documentation.Code Example Modernization:
Deprecated/Preview Notice Removal:
References: [1] [2] [3]