Skip to content

Conversation

mbohal
Copy link
Contributor

@mbohal mbohal commented Dec 13, 2022

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.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Dec 13, 2022
@mbohal
Copy link
Contributor Author

mbohal commented Dec 21, 2022

So apparently the props table on Mac OS when built (not run in dev server) does not work :(

The rest seems to be fine and can be reviewed.

All is OK now.

Copy link
Contributor

@bedrich-schindler bedrich-schindler left a 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.

@davidurban
Copy link

@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.

@mbohal
Copy link
Contributor Author

mbohal commented Jan 9, 2023

@davidurban wrote:

There still is a problem of inaccessible docoff styles – code playgrounds use larger font size than other code fields.

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.

@davidurban
Copy link

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.
Ok, I understand. In that case however, we need a clear way to override playground styles to match the rest of documentation.

@mbohal
Copy link
Contributor Author

mbohal commented Jan 10, 2023

There still is a problem of inaccessible docoff styles – code playgrounds use larger font size than other code fields.

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.

Copy link
Member

@adamkudrna adamkudrna left a 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 READMEs 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% in main.css. I'll fix it within extra.css soon—it will take some time because the entire font-size cascade in the docs styles must be changed 🙈.

Copy link
Member

@adamkudrna adamkudrna left a 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!

Copy link
Member

@adamkudrna adamkudrna left a 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?

@adamkudrna
Copy link
Member

The live preview still needs some attention (from me) to win the z-index war:

obrazek

@mbohal
Copy link
Contributor Author

mbohal commented Jul 26, 2023

To deal wit the Modal z-index issue i created #471

@mbohal mbohal force-pushed the docs/373 branch 5 times, most recently from 8b21b1b to dcbf836 Compare August 2, 2023 16:03
Copy link
Member

@adamkudrna adamkudrna left a comment

Choose a reason for hiding this comment

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

👏🏻 🎉

@adamkudrna adamkudrna force-pushed the docs/373 branch 7 times, most recently from d5cea75 to d425cf7 Compare August 2, 2023 21:31
@adamkudrna adamkudrna changed the title Change documentation platform from Docz to Docoff Change documentation platform from Docz to MkDocs with Docoff (#373) Aug 2, 2023
@adamkudrna adamkudrna force-pushed the docs/373 branch 2 times, most recently from 3854190 to 8ce7147 Compare August 2, 2023 22:01
@adamkudrna adamkudrna self-assigned this Aug 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Drop Docz in favour of a non-Gatsby solution
4 participants