-
-
Notifications
You must be signed in to change notification settings - Fork 8.8k
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(v2): Docs refactoring and reorganization #3831
Conversation
Deploy preview for docusaurus-2 ready! Built with commit 23ad5f4 |
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3831--docusaurus-2.netlify.app/classic/ |
Size Change: +1.48 kB (0%) Total Size: 157 kB
ℹ️ View Unchanged
|
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 really like the API sidebar reorganization and packages emoji marks, good work on that! 🙂 |
glad you like it :) let's merge then |
Motivation
Our doc is quite messy, we should re-organize it so that it's easier to navigate in.
Some says that there are "4 kind of docs" (https://documentation.divio.com/):
Not everybody will agree with this vision (after discussions on WriteTheDocs slack), but still probably a good start.
A low-hanging fruit is to split very large doc pages into smaller ones, and move all reference/api doc to the API tab.
It's better to have 1 page per plugin than to have a very large plugins page.