-
-
Notifications
You must be signed in to change notification settings - Fork 8.6k
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): Move sidebar content to its own page #3899
Conversation
Hi @ArtFlag! Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks! |
✔️ Deploy preview for docusaurus-2 ready! 🔨 Explore the source changes: 51b74f7 🔍 Inspect the deploy logs: https://app.netlify.com/sites/docusaurus-2/deploys/5fd35bc02564a100073ae71c 😎 Browse the preview: https://deploy-preview-3899--docusaurus-2.netlify.app |
Size Change: +15 B (0%) Total Size: 154 kB ℹ️ View Unchanged
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks! |
Thanks, that looks like a good idea to me, but will be easier to review if the deploy preview works :) |
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-3899--docusaurus-2.netlify.app/classic/ |
@ArtFlag there is now a problem in the deploy preview: https://deploy-preview-3899--docusaurus-2.netlify.app/classic/docs/sidebar Also, can you comment in this PR the parts of the doc you modified? As the content is both moved/updated, highlighting the major doc changes would be helpful, but overall it looks good |
Thanks for fixing the issues! I've mostly modified the section about the The rest of the page has seen some modifications but mostly to reduce word count. For example, for the shorthand note that you mentioned: we used to give the shorthand first and then explain what the "normal" version is. No content has been deleted. |
Thanks Can you fix the git conflict and the admonition mistake so that I can merge this? |
ca58643
to
51b74f7
Compare
It should be fine now. FYI I couldn't push my docs update because pre-commit thought it was an empty commit. Not sure if this update came from my rebase on master, but if there's a way to fix (ignore docs?) that would be nice 👍 |
thanks not sure what you are talking about but that looks fine to merge :) |
Motivation
Related to #3893 and #3894.
TOCs or sidebars are extremely important in any docs website.
In the current version, the sidebar info is inside the
intro
page and the sidebar sections are from H3 and deeper, meaning they do not appear in the right-hand TOC making it difficult to browse and understand.With this PR, the sidebar info is in its own page. It appears in the sidebar, and the on-page TOC is useful again.
I've touched up the content a little bit to reduce word count, also see the
Test plan
section below.Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Please take a solid look at the
Understanding sidebar items
section.Task-oriented docs are generally much better for new users, so I've reworked the titles and description to tell us what each type does immediately, instead of telling us the name of each type first (also helps with SEO).
Let me know if this is correct or if needs improvements, I'll take care of it swiflty.
The rest has only changed a little.