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(content-docs): deduplicate types, JSDoc for some APIs #7027

Merged
merged 2 commits into from
Mar 27, 2022

Conversation

Josh-Cena
Copy link
Collaborator

@Josh-Cena Josh-Cena commented Mar 27, 2022

Breaking change

This should be mostly internal, but if you enhanced the doc plugin or monkey-patched it in a 3rd party plugin and relied on internal data structures like version metadata, their shapes may have changed. Most notably, versionMetadata.version* have the version prefix stripped except for versionName, so versionBadge becomes badge, versionPath -> path, etc. Swizzled themes or client APIs are not affected.

Motivation

The great type deduplication, because we want to re-use JSDoc😞

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Build

@Josh-Cena Josh-Cena added pr: breaking change Existing sites may not build successfully in the new version. Description contains more details. pr: maintenance This PR does not produce any behavior differences to end users when upgrading. labels Mar 27, 2022
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Mar 27, 2022
@netlify
Copy link

netlify bot commented Mar 27, 2022

[V2]

Name Link
🔨 Latest commit 8524966
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/623febcbbe30e6000950781a
😎 Deploy Preview https://deploy-preview-7027--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

github-actions bot commented Mar 27, 2022

⚡️ Lighthouse report for the changes in this PR:

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

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

@github-actions
Copy link

github-actions bot commented Mar 27, 2022

Size Change: 0 B

Total Size: 806 kB

ℹ️ View Unchanged
Filename Size
website/.docusaurus/globalData.json 49.9 kB
website/build/assets/css/styles.********.css 105 kB
website/build/assets/js/main.********.js 613 kB
website/build/index.html 38.4 kB

compressed-size-action

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: breaking change Existing sites may not build successfully in the new version. Description contains more details. pr: maintenance This PR does not produce any behavior differences to end users when upgrading.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants