Skip to content
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

Merged
merged 6 commits into from
Nov 30, 2020
Merged

Conversation

slorber
Copy link
Collaborator

@slorber slorber commented Nov 27, 2020

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.

image

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.

@slorber slorber requested a review from lex111 as a code owner November 27, 2020 11:53
@slorber slorber marked this pull request as draft November 27, 2020 11:53
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Nov 27, 2020
@slorber slorber added pr: documentation This PR works on the website or other text documents in the repo. CLA Signed Signed Facebook CLA and removed CLA Signed Signed Facebook CLA labels Nov 27, 2020
@netlify
Copy link

netlify bot commented Nov 27, 2020

Deploy preview for docusaurus-2 ready!

Built with commit 23ad5f4

https://deploy-preview-3831--docusaurus-2.netlify.app

@github-actions
Copy link

github-actions bot commented Nov 27, 2020

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 80
🟢 Accessibility 99
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-3831--docusaurus-2.netlify.app/classic/

@github-actions
Copy link

github-actions bot commented Nov 27, 2020

Size Change: +1.48 kB (0%)

Total Size: 157 kB

Filename Size Change
website/build/main.********.js 113 kB +1.5 kB (1%)
ℹ️ View Unchanged
Filename Size Change
website/build/blog/2017/12/14/introducing-docusaurus/index.html 20.7 kB -8 B (0%)
website/build/docs/introduction/index.html 180 B 0 B
website/build/index.html 5.86 kB -13 B (0%)
website/build/styles.********.css 17.4 kB 0 B

compressed-size-action

@slorber slorber marked this pull request as ready for review November 27, 2020 20:41
@slorber
Copy link
Collaborator Author

slorber commented Nov 27, 2020

Wonder what you think about this refactor @lex111 @Simek @yangshun

Affected pages:

Copy link
Contributor

@lex111 lex111 left a comment

Choose a reason for hiding this comment

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

👏

@Simek
Copy link
Contributor

Simek commented Nov 30, 2020

I really like the API sidebar reorganization and packages emoji marks, good work on that! 🙂

@slorber
Copy link
Collaborator Author

slorber commented Nov 30, 2020

glad you like it :)

let's merge then

@slorber slorber merged commit 8f47bab into master Nov 30, 2020
@slorber slorber deleted the slorber/docs-reorg branch August 17, 2021 17:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants