Skip to content

Conversation

@alexgrozav
Copy link
Contributor

This pull request updates the documentation for Styleframe design tokens, focusing on improving code sample clarity and consistency across multiple pages. The main changes involve renaming files for better organization and adding explicit language and file annotations to code blocks, making it easier for users to identify configuration and output files. Additionally, section headings and terminology have been refined for clarity.

Documentation improvements:

  • All code samples now include explicit file annotations, such as [styleframe.config.ts] for configuration and [styleframe/index.css] for output, to clarify their context and improve readability. [1] [2]
  • Section headings and terminology have been updated (e.g., "Foundation Tokens" changed to "Composables") for better conceptual clarity in the documentation.

File organization:

  • The main design tokens overview file was renamed from 00.overview.md to 00.index.md for improved documentation structure.

Consistency across documentation:

  • All border, box shadow, and color-related documentation pages now use consistent code block annotations to distinguish between configuration and output examples. [1] [2] [3] [4] [5]

Composables and usage examples:

  • Usage examples for composables such as useBorderStyle, useBorderWidth, useBorderColor, and others have been updated to reflect the new annotation format and improved sample clarity. [1] [2] [3] [4]

Theme support and advanced examples:

  • Examples demonstrating theme support, color manipulation, and comprehensive border systems have been updated to use the new code block annotation style. [1] [2]

Let me know if you have any questions about the new documentation standards or how to apply these changes in your own docs!

@alexgrozav alexgrozav self-assigned this Nov 11, 2025
@changeset-bot
Copy link

changeset-bot bot commented Nov 11, 2025

⚠️ No Changeset found

Latest commit: 1d40124

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 Nov 11, 2025

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

Project Deployment Preview Comments Updated (UTC)
styleframe-dev-production Ready Ready Preview Comment Nov 11, 2025 7:01am

@codecov
Copy link

codecov bot commented Nov 11, 2025

Codecov Report

❌ Patch coverage is 46.66667% with 8 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
engine/core/src/utils/merge.ts 33.33% 8 Missing ⚠️

📢 Thoughts on this report? Let us know!

@alexgrozav alexgrozav merged commit 6f61a52 into main Nov 11, 2025
9 of 10 checks passed
@alexgrozav alexgrozav deleted the fluid-design-docs branch November 11, 2025 09:02
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