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(theming): clarify how nuxt ui augments tailwind config #2010

Open
wants to merge 22 commits into
base: dev
Choose a base branch
from

Conversation

davestewart
Copy link
Contributor

@davestewart davestewart commented Aug 2, 2024

🔗 Linked issue

Relates to:

❓ Type of change

  • 📖 Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • 👌 Enhancement (improving an existing functionality)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

This PR attempts to clarify the docs:

  1. if feat(module): reuse existing primary and gray colors #2009 is merged, then the information about incompatible key names is no longer valid
  2. rather than offering vague information about variables, the new docs describe exactly how they work
  3. clarifies how primary and gray relate to the components

See comment in related PR:

Note

I can't build the docs, so I'll have to check my work using the Vercel preview!

📝 Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@davestewart
Copy link
Contributor Author

Hmmm. I thought the preview would let me view the updated docs, but I only see the old docs ☹️

@benjamincanac
Copy link
Member

benjamincanac commented Aug 2, 2024

@davestewart Thanks a lot for this! Have you selected nuxt/ui-edge in the top left dropdown?
CleanShot 2024-08-02 at 15 59 05@2x

Also, do you have an issue running the docs locally?

@davestewart
Copy link
Contributor Author

davestewart commented Aug 2, 2024

Have you selected nuxt/ui-edge in the top left dropdown?

Ah – fantastic!

Also, do you have an issue running the docs locally?

Yeah, I can't run the docs locally as I'm not a Nuxt UI Pro customer

@davestewart
Copy link
Contributor Author

Great! I can see it the right docs now.

A few tweaks needed which I'll have time to make later on.

@benjamincanac
Copy link
Member

You don't need to have a Nuxt UI Pro license to run the docs, it's only required to build 😊

@benjamincanac benjamincanac changed the title docs(Theming): clarify how nuxt ui augments tailwind config docs(theming): clarify how nuxt ui augments tailwind config Aug 4, 2024
@davestewart
Copy link
Contributor Author

Sorry for all the updates. I could tweak doc wording all day! (and I do 😅)

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