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): use explicit heading IDs #4460

Merged
merged 1 commit into from
Mar 19, 2021
Merged

docs(v2): use explicit heading IDs #4460

merged 1 commit into from
Mar 19, 2021

Conversation

lex111
Copy link
Contributor

@lex111 lex111 commented Mar 18, 2021

Motivation

I propose to dogfood on the website v2 use explicit heading IDs

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Preview.

Related PRs

(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)

@lex111 lex111 added the pr: documentation This PR works on the website or other text documents in the repo. label Mar 18, 2021
@lex111 lex111 requested a review from slorber as a code owner March 18, 2021 17:53
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Mar 18, 2021
@netlify
Copy link

netlify bot commented Mar 18, 2021

[V1] Deploy preview success

Built with commit 15f49d9

https://deploy-preview-4460--docusaurus-1.netlify.app

@github-actions
Copy link

Size Change: 0 B

Total Size: 575 kB

ℹ️ View Unchanged
Filename Size Change
website/build/assets/css/styles.********.css 87.2 kB 0 B
website/build/assets/js/main.********.js 401 kB 0 B
website/build/blog/2017/12/14/introducing-docusaurus/index.html 60.8 kB 0 B
website/build/docs/introduction/index.html 235 B 0 B
website/build/index.html 25.7 kB 0 B

compressed-size-action

@netlify
Copy link

netlify bot commented Mar 18, 2021

Deploy preview for docusaurus-2 ready!

Built with commit 15f49d9

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

@github-actions
Copy link

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 87
🟢 Accessibility 96
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

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

@slorber
Copy link
Collaborator

slorber commented Mar 18, 2021

totally agree we should use this

I'd also like the cli command to have an option to fail if there is any non-explicit heading found in the project, ensuring we have 100% explicit ids in a project, what do you think about this?

@lex111
Copy link
Contributor Author

lex111 commented Mar 18, 2021

Yep, maybe it makes sense, not sure.

@slorber slorber merged commit 291a72f into master Mar 19, 2021
@slorber slorber deleted the lex111/exp-ids-doc branch August 17, 2021 18:02
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.

3 participants