Skip to content

Improve documentation #2280

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

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Improve documentation #2280

wants to merge 5 commits into from

Conversation

thecrypticace
Copy link
Contributor

@thecrypticace thecrypticace commented Jun 17, 2025

This is a bit of a catchall PR for some documentation updates

Copy link

vercel bot commented Jun 17, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
tailwindcss-com ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 18, 2025 4:00pm

@@ -287,3 +287,5 @@ Use the `theme()` function to access your Tailwind theme values using dot notati
```

This function is deprecated, and we recommend [using CSS theme variables](/docs/theme#using-your-theme-variables) instead.

The `@config` and `@plugin` directives may be used in conjunction with `@theme`, `@utility`, and other CSS-driven features. This can be used to incrementally move over your theme, custom configuration, utilities, variants, and presets to CSS. Things defined in CSS will be merged where possible and otherwise take precedence over those defined in configs, presets, and plugins.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this should be at the top of the compatibility section (after existing opening sentence probably), it feels like it's in the theme() function documentation right now since that's the heading it's under which doesn't feel right to me.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah I wasn't quite sure where to put it. Immediately after @config but before @plugin feels incorrect. It feels to me like this is a "note" of sorts that maybe should stand out separately from the rest of the content but not sure.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went ahead and moved this to just below the opening sentence. I think it feels fine there.

I added this to the upgrade guide previously but we should add it here too.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants