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

refactor: mark toc in loaded MDX as non-optional #7524

Merged
merged 1 commit into from
May 29, 2022

Conversation

Josh-Cena
Copy link
Collaborator

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

I got confused when writing the type declarations. The loaded MDX actually always has a toc variable available, even if it's just an empty array. I've updated the type defs and made relevant refactors.

Made a test to make this clearer.

Test Plan

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs

@Josh-Cena Josh-Cena added the pr: internal This PR does not touch production code, or is not meaningful enough to be in the changelog. label May 29, 2022
@Josh-Cena Josh-Cena requested review from slorber and lex111 as code owners May 29, 2022 14:22
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label May 29, 2022
@netlify
Copy link

netlify bot commented May 29, 2022

[V2]

Name Link
🔨 Latest commit 0ccb493
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/62938192b6aca600093cbd29
😎 Deploy Preview https://deploy-preview-7524--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 77 🟢 100 🟢 100 🟢 100 🟢 90 Report
/docs/installation 🟠 87 🟢 99 🟢 100 🟢 100 🟢 90 Report

@github-actions
Copy link

Size Change: 0 B

Total Size: 797 kB

ℹ️ View Unchanged
Filename Size
website/.docusaurus/globalData.json 52.5 kB
website/build/assets/css/styles.********.css 106 kB
website/build/assets/js/main.********.js 600 kB
website/build/index.html 38.9 kB

compressed-size-action

@Josh-Cena Josh-Cena merged commit f443e99 into main May 29, 2022
@Josh-Cena Josh-Cena deleted the jc/mark-non-optional branch May 29, 2022 14:36
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: internal This PR does not touch production code, or is not meaningful enough to be in the changelog.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants