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

[BUG] - Fix tailwind themes in docs #2808

Merged
merged 1 commit into from
Sep 17, 2024
Merged

[BUG] - Fix tailwind themes in docs #2808

merged 1 commit into from
Sep 17, 2024

Conversation

itaismith
Copy link
Contributor

@itaismith itaismith commented Sep 16, 2024

Description of changes

Tailwind dark-mode did not respond to changes properly since next-themes uses data-theme="dark" to apply dark mode styling to elements in this project.

This made it hard to develop dark mode styling for custom components on the docs site.

Test plan

Visually tested with npm run dev. Notice that in production the "sun" doesn't change to a "moon" when applying dark mode (this should happen on the tailwind styling).

Documentation Changes

Not needed.

Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

@jeffchuber
Copy link
Contributor

CleanShot 2024-09-16 at 16 58 15@2x

@itaismith the header is the wrong color - will dig in more tonight

@itaismith
Copy link
Contributor Author

itaismith commented Sep 17, 2024

@jeffchuber If you remove dark:bg-stone-950 from line 13 in TopNav.tsx it should default to the ShadCn coloring we have in prod. This style wasn't applied before because the tailwind dark mode wasn't actually working.

I went ahead and removed it!

Copy link
Contributor

@jeffchuber jeffchuber left a comment

Choose a reason for hiding this comment

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

ty! 🫡

@itaismith itaismith merged commit efea481 into main Sep 17, 2024
10 checks passed
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