Skip to content
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

docs: upgrade guide, remind people to upgrade third-party configs like tailwind.config.js #27768

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

cheike569
Copy link

@cheike569 cheike569 commented Jun 21, 2024

https://nuxt.com/docs/getting-started/upgrade

It should be noted to upgrade any third-party libraries that depend on the directory structure in the "New Directory Structure" Section. This may be Tailwind CSS in many circumstances.

📚 Description

The Nuxt 4 Upgrade Guide includes a significant change, which is the new Directory Structure.

Since many projects depend on third-party libraries and processors, a reminder to upgrade these configs in your project as well might be beneficial, namely tailwind.config.js

…e tailwind.config.js

In the "New Directory Structure" Section, it should be mentioned to upgrade any third-party libraries depending on the directory structure. In many cases, this might be Tailwind CSS.
Copy link

stackblitz bot commented Jun 21, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

@danielroe
Copy link
Member

cc: @ineshbose - do you think we need to do anything else here?

@ineshbose
Copy link
Member

ineshbose commented Jun 21, 2024

cc: @ineshbose - do you think we need to do anything else here?

Thanks for pinging!

I tend to discourage users from specifying Nuxt directory paths within Tailwind config as the module already adds in their resolved paths, and if nuxt.options.dir will also consider the appDir automatically, the module should still work. Maybe the doc can remind them to review any content paths with an alert saying that @nuxtjs/tailwindcss automatically resolves the required paths for Nuxt directories.

Can we also think of other third-party examples for this step?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants