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: editorial fixes #6889

Merged
merged 1 commit into from
Mar 10, 2022
Merged

docs: editorial fixes #6889

merged 1 commit into from
Mar 10, 2022

Conversation

Josh-Cena
Copy link
Collaborator

Motivation

A lot of really minor improvements

Have you read the Contributing Guidelines on pull requests?

Yes

@Josh-Cena Josh-Cena added the pr: documentation This PR works on the website or other text documents in the repo. label Mar 10, 2022
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Mar 10, 2022
@netlify
Copy link

netlify bot commented Mar 10, 2022

✔️ [V2]

🔨 Explore the source changes: a3f8a35

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/62298df8bbc53200096cbdca

😎 Browse the preview: https://deploy-preview-6889--docusaurus-2.netlify.app

@github-actions
Copy link

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 46
🟢 Accessibility 100
🟢 Best practices 92
🟢 SEO 100
🟢 PWA 90

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

@Josh-Cena Josh-Cena merged commit 2648ec0 into main Mar 10, 2022
@Josh-Cena Josh-Cena deleted the jc/fix-docs branch March 10, 2022 05:43
@github-actions
Copy link

Size Change: +1.07 kB (0%)

Total Size: 792 kB

Filename Size Change
website/build/assets/js/main.********.js 598 kB +1.07 kB (0%)
ℹ️ View Unchanged
Filename Size
website/.docusaurus/globalData.json 49.9 kB
website/build/assets/css/styles.********.css 105 kB
website/build/index.html 38.7 kB

compressed-size-action

@@ -53,12 +47,19 @@ import TOCInline from '@theme/TOCInline';
<TOCInline
// Only show h2 and h4 headings
toc={toc.filter((node) => node.level === 2 || node.level === 4)}
minHeadingLevel={2}
Copy link
Collaborator

Choose a reason for hiding this comment

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

seems weird to use filter + min/max at the same time?

Copy link
Collaborator Author

@Josh-Cena Josh-Cena Mar 10, 2022

Choose a reason for hiding this comment

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

filter filters out the h3 nodes. But when the h4 nodes are passed into TOCInline, they are still being ignored by the component if maxHeadingLevel is not configured to be 4. I don't think there's much we can do, because no-one knows that a filter happened on the user-side.

Copy link
Collaborator

Choose a reason for hiding this comment

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

I see thanks

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.

None yet

3 participants