-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
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
docs: use Mermaid diagram for routing page #8335
Conversation
✅ [V2]Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
⚡️ Lighthouse report for the deploy preview of this PR
|
Why not 🤷♂️ any opinion @Josh-Cena ? What I don't like is that the Mermaid diagram is generated client-side and produce layout shifts (+ no caching):
I'm not 100% sure it improves the user experience, but I'm not against this change either |
I like the change 👍 It means smaller assets, better maintainability (we can easily edit the diagrams in the future without me sharing my TeX source code and asking you to compile it to PDF then to PNG), and some dogfooding. If the UX is not great, that's a general problem of all Mermaid diagrams, but if that didn't prevent us from shipping the feature, it shouldn't prevent us from using it either. @Mysterious-Dev Remember to remove the existing assets, though. We don't need them anymore. (You can also edit the versioned docs so we can safely remove them from the project) |
Agree 👍 Let's dogfood this. It should also improve the ability to translate the diagram. If I don't like the experience I can just improve it later 🤪 @Mysterious-Dev waiting for your update before merging |
@slorber Done (for files & older versions). |
Pre-flight checklist
Motivation
By the addition of mermaid in 2.2.0, somes image can be remplaced by mermaid graph.
Before :
After :
Test links
Deploy preview: https://deploy-preview-8335--docusaurus-2.netlify.app/docs/advanced/routing/