Improve v3 docs regarding compatibility with vite_rails #8548
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Active Admin v3 can be used with the vite_rails gem, but the instructions for doing so are buried in a discussion comment. Also, using a modern build system like Vite will often lead to deprecation warnings due to the older color functions used in Active Admin's SCSS assets. To address these issues, I've made some small improvements to Active Admin's docs. Namely: - Add a vite_rails section to the installation document. - Mention the SCSS deprecation warnings in the "gotchas" document, with a workaround that specifically works with Vite. As discussed in <activeadmin#8492>, it would be great to solve the deprecation warnings rather than just hiding them, but that will require some significant refactoring, which can be a separate PR. In the meantime I wanted to improve the documentation to at least point users in the right direction.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## 3-0-stable #8548 +/- ##
=============================================
Coverage ? 99.19%
=============================================
Files ? 194
Lines ? 4965
Branches ? 0
=============================================
Hits ? 4925
Misses ? 40
Partials ? 0 ☔ View full report in Codecov by Sentry. 🚨 Try these New Features:
|
|
@mattbrictson thank you. This is very helpful. I don't mind duplicating on the v3 branch for historical purposes but this should be on the default branch, at least in addition, because that's the only place from where we deploy the docs to the web. Would you be ok with creating another PR against the default branch? I'm treating the docs there as v3 for now. We are trying to figure out how to split the docs within Vitepress. |
|
@javierjulio Yes, I'll open another PR for the default branch. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Active Admin v3 can be used with the vite_rails gem, but the instructions for doing so are buried in a discussion comment.
Also, using a modern build system like Vite will often lead to deprecation warnings due to the older color functions used in Active Admin's SCSS assets.
To address these issues, I've made some small improvements to Active Admin's docs. Namely:
As discussed in #8492, it would be great to solve the deprecation warnings rather than just hiding them, but that will require some significant refactoring, which can be a separate PR. In the meantime I wanted to improve the documentation to at least point users in the right direction.