Skip to content

WIP: upgrade Docusaurus - #3022

Closed
slorber wants to merge 1 commit into
react:mainfrom
slorber:slorber/docu-up
Closed

WIP: upgrade Docusaurus#3022
slorber wants to merge 1 commit into
react:mainfrom
slorber:slorber/docu-up

Conversation

@slorber

@slorber slorber commented Mar 18, 2022

Copy link
Copy Markdown
Contributor

Upgrade of Docusaurus:


WIP as there are some remaining CSS issues to fix

Comment thread website/package.json
Comment on lines +45 to +47
"@docusaurus/core": "0.0.0-4738",
"@docusaurus/plugin-pwa": "0.0.0-4738",
"@docusaurus/preset-classic": "0.0.0-4738",

@Simek Simek Mar 18, 2022

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Can we wait until next beta is released? The class name issue doesn't seems that crucial to stick to nightlines. 😅

Also Algolia and GA stuff should not be linked to the CSS problems, right? Saying that, I was planning to upgrade to latest beta this weekend, so if changing that to beta.17 also helps that would be fine.

@netlify

netlify Bot commented Mar 18, 2022

Copy link
Copy Markdown

✅ Deploy Preview for react-native ready!

🔨 Explore the source changes: 08072e9

🔍 Inspect the deploy log: https://app.netlify.com/sites/react-native/deploys/6234ceec73a8c900085b3ef0

😎 Browse the preview: https://deploy-preview-3022--react-native.netlify.app

@Simek

Simek commented Mar 18, 2022

Copy link
Copy Markdown
Collaborator

Looking at the deploy, there are few thing which doesn't seems correct right now:

  • hover effect for the new theme toggler
  • new top page navigation readability could be improved, especially for active element in light mode (I also don't like the hover effect there, for non interactable parts, like top level sidebar groups, which can be misleading)
  • it looks like there is regression with sidebar headers styling in the dark mode (dark font is used)

Also, personally I think that including the page name in this navigation is redundant and looks a bit weird, when title is listed twice, and both those text are non-interactable. Besides the "home" link (which do the same as logo) the new component doesn't add any other function, besides displaying navigation structure:

Screenshot 2022-03-18 194226

Is it possible to turned this feature off? Not sure if we want that, but it would be nice to know.

@slorber

slorber commented Mar 24, 2022

Copy link
Copy Markdown
Contributor Author

Thanks for the review

This is a WIP PR to help you with the breaking changes and so that I know what else breaks on upgrade.

I'll be on holiday and will do a release before so if you want to give it a try until then let me know, otherwise we'll wait 2 weeks 😄

@Josh-Cena

Copy link
Copy Markdown

Besides the "home" link (which do the same as logo) the new component doesn't add any other function, besides displaying navigation structure:

That's because the RN website currently doesn't take advantage of the new category index pages. If a category has a link associated, the respective breadcrumb item will be clickable. But given the flat nature of the website's navigation system, maybe the breadcrumbs aren't useful at all?

@Josh-Cena

Josh-Cena commented Apr 6, 2022

Copy link
Copy Markdown

The color mode toggle hover style is a(n inconsiderate) bug(maybe it's not a bug? The search bar assumes different background colors as well) with Docusaurus. It only takes the default navbar style into account

@Simek

Simek commented Apr 6, 2022

Copy link
Copy Markdown
Collaborator

Thanks for the explanation @Josh-Cena!

Maybe we leverage this feature in the future, while reworking Architecture and Contributing parts, but for now I have disabled them in my PR, via breadcrumbs: false option added to all instances of the docs plugin.

Other issues are also fixed in my PR, there were few more than reported in there, the most problematic was not working chevron displayed, even when collapsible was set to false.

@slorber

slorber commented Apr 7, 2022

Copy link
Copy Markdown
Contributor Author

Replaced by #3059

@slorber slorber closed this Apr 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants