-
Notifications
You must be signed in to change notification settings - Fork 7
Change documentation platform from Docz to MkDocs with Docoff (#373) #440
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
Conversation
All is OK now. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just reviewed live preview, not the code as there will be more changes in response to my comments.
@bedrich-schindler I have improved styles, reduced font size in some cases and made other small tweaks to improve usability. There still is a problem of inaccessible docoff styles – code playgrounds use larger font size than other code fields. Also their background styling is different and because of used transparency and lack of dark/light theme support it is complicated to match it. |
@davidurban wrote:
That is not a bug, that is a feature :) . Playground code and playground live preview each have their own dedicated shadowDOM to prevent style leaks between them. It is a design decision that was taken to make sure that the documentation platform styles can change with no danger that the UI library looks will unchange in an unforseen way. |
|
I think this has been resolved by new version of Docoff. Further improvement is possible by adding PrismJS to MkDocs, but I would prefer not to worry about it now. I'm not even sure if it is necessary. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- ✅ I did a thorough CR of the changes in the code, except some component
README
s whose changes cannot be previewed here on GitHub. ⚠️ There are still technical things to be fixed (detail, IMO) or discussed (the structure of URIs and redirects).- 👁️ I just checked the output in the browser very quickly to be able to focus on the major visual issues like the font size or syntax highlighting. Please expect one more round of me.
- 🅰 Speaking of the font size, it's a problem of
font-size: 125%
inmain.css
. I'll fix it withinextra.css
soon—it will take some time because the entire font-size cascade in the docs styles must be changed 🙈.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There will be some more updating once you rebase your changes. Then I'd like to check the PR one last time, just for sure. But all the rest looks good to me now!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
So, finally! I found and fixed many things (including fixes in Docoff), yet there are some issues I cannot fix myself.
My biggest confusion comes from all the magic with CSS… Let's have a call maybe to make it clear?
src/components/Table/_components/TableHeaderCell/TableHeaderCell.jsx
Outdated
Show resolved
Hide resolved
To deal wit the Modal |
8b21b1b
to
dcbf836
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👏🏻 🎉
d5cea75
to
d425cf7
Compare
3854190
to
8ce7147
Compare
This is a huge PR, so I'm not adding everyone.
It is based on work done by @davidurban , so big thanks to him. I tweaked it and add some things, but he did most of the work.
There are still some problems. Most, if not all of them, are related to styling and I'm having hard time figuring it out.
I hope @adamkudrna will be able to help.
Also test are falling. I will deal with the rest, but the stylelint error I'm unsure what to do with
Closes #373.