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

Add installation steps for Tailwind CSS v4.0 & Linux environments #157

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

Conversation

aurepereira
Copy link
Contributor

@aurepereira aurepereira commented Jan 25, 2025

Description

Closes #156

What's been done?

  • Added a callout in the Installation section warning to users to select the correct version of Tailwind CSS they plan on using. Users can navigate to the correct section by clicking on the appropriate link
    image

  • Added installation steps in the documentation to use Tailwind CSS v4.0. These instructions are displayed along with the original installation instructions, which are now labeled Instructions for Tailwind CSS v3.*

  • Added extra steps in the documentation to download and start Tailwind CSS as part of the build, for both Windows and Linux environments
    image

Checklist

  • My code follows the project's coding style and guidelines.
  • I have included inline docs for my changes, where applicable.
  • I have added, updated or removed tests according to my changes.
  • All tests are passing.
  • There's an open issue for the PR that I am making.

Additional Notes

Copy link

coderabbitai bot commented Jan 25, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@aurepereira
Copy link
Contributor Author

@desmondinho been able to work on this a little today, however it seems I cannot get the title from the DocsSection in Installation.razor to display correctly?

I expected them to be bold and have some breathing room around them, but nope.

image

Can you see anything in the code I might've missed perhaps? If not I will find a different solution.

@desmondinho
Copy link
Contributor

Thank you very much for starting this PR!

Can you see anything in the code I might've missed perhaps? If not I will find a different solution.

Yes, the reason behind it is that these DocsSections are not wrapped with the prose class :/
I did so to prevent <ul> and <li> elements (installation steps) to apply the prose styles.

Copy link
Contributor

@desmondinho desmondinho left a comment

Choose a reason for hiding this comment

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

I love it ❤️

Btw, I am almost done with the new LumexTab component that we could actually use on this page to make it a bit more compact. I think that I will it this weekend.

@aurepereira
Copy link
Contributor Author

Thank you very much for starting this PR!

Can you see anything in the code I might've missed perhaps? If not I will find a different solution.

Yes, the reason behind it is that these DocsSections are not wrapped with the prose class :/ I did so to prevent <ul> and <li> elements (installation steps) to apply the prose styles.

Ah, got it. I have found an easy workaround, those section titles should now display correctly.

I love it ❤️

Btw, I am almost done with the new LumexTab component that we could actually use on this page to make it a bit more compact. I think that I will it this weekend.

Nice! Then I guess we should wait for this shiny new component to be available to complete this PR, no?

@desmondinho
Copy link
Contributor

desmondinho commented Jan 25, 2025

Great!

Nice! Then I guess we should wait for this shiny new component to be available to complete this PR, no?

Yes, I’ll keep you updated!

@desmondinho
Copy link
Contributor

Hey @aurepereira,

I’ve had some more time to think about this, and I’ve concluded that it might not be the best time to introduce a full-fledged installation process with Tailwind CSS v4. Here’s why:

  1. It will imply that the library fully supports v4, but some styles will not work as expected.
  2. It will suggest that all dependencies fully support v4, but LumexUI uses tailwind-merge-dotnet under the hood, which doesn’t support v4 yet.

For now, I think the best approach would be to:

  • Update the link in step 2 to point to the Tailwind CSS v3 documentation.
  • Add a warning callout for those who want to use v4 regardless. The callout will reference a related issue or discussion we create here.
  • Once LumexUI is fully compatible with v4, we will revisit the installation process topic.

What do you think about this plan?

@aurepereira
Copy link
Contributor Author

@desmondinho yeah man that totally works for me, that is a very valid point. Let's shelve this PR for now, I just opened a smaller one adding just the changes you suggested: #160

Let me know if the wording isn't to your liking, in the meantime I will also reference this conversation in #156

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.

[Feature]: Add compatibility with Tailwind CSS 4.0
2 participants