Skip to content

Conversation

@alexgrozav
Copy link
Contributor

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:

  • The original 10.recipes.md file 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:

  • The new 00.index.md provides a clearer introduction to recipes, step-by-step examples of defining recipes, and detailed explanations of recipe options, variants, default variants, and compound variants.
  • The documentation now includes best practices and an expanded FAQ section, comparing Styleframe recipes to similar solutions (CVA, Panda CSS, Stitches) and providing guidance on composition and extension.

Navigation and Metadata Updates:

  • Navigation titles and icons for the Recipes section have been moved to .navigation.yml for better organization and consistency with the rest of the documentation.

Code Example Modernization:

  • All code samples have been updated for clarity and modern usage, demonstrating the latest recommended patterns for defining tokens, utilities, and recipes in Styleframe.

Deprecated/Preview Notice Removal:

  • The warning about recipes being under active development has been removed, indicating that the feature is now officially documented and available.

References: [1] [2] [3]

@alexgrozav alexgrozav requested a review from Copilot January 3, 2026 19:27
@alexgrozav alexgrozav self-assigned this Jan 3, 2026
@changeset-bot
Copy link

changeset-bot bot commented Jan 3, 2026

⚠️ No Changeset found

Latest commit: cd50c65

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@vercel
Copy link

vercel bot commented Jan 3, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
app-styleframe-dev-production Ready Ready Preview, Comment Jan 3, 2026 7:29pm
styleframe-dev-production Ready Ready Preview, Comment Jan 3, 2026 7:29pm

Copy link
Contributor

Copilot AI left a 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
Copy link

codecov bot commented Jan 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@alexgrozav alexgrozav merged commit 6de904b into main Jan 3, 2026
17 checks passed
@alexgrozav alexgrozav deleted the recipes-docs branch January 3, 2026 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants