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-blog): clean up type definitions; in-code documentation #6922

Merged
merged 2 commits into from
Mar 16, 2022

Conversation

Josh-Cena
Copy link
Collaborator

Motivation

This is part of a bigger effort to make our codebase more approachable, both for internal types and the types exposed to end-users. For example, since we have JSDoc in the config file, the user can now use intellisense to see the documentation for any option:

image

It also means we can achieve #6649 without actually writing much Markdown. We may investigate migrating our API documentation to Typedoc later, so we don't maintain two sets of documentation (JSDoc and Markdown)

Have you read the Contributing Guidelines on pull requests?

Yes

@Josh-Cena Josh-Cena added the pr: maintenance This PR does not produce any behavior differences to end users when upgrading. label Mar 16, 2022
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Mar 16, 2022
@netlify
Copy link

netlify bot commented Mar 16, 2022

✔️ [V2]

🔨 Explore the source changes: 5c52eba

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

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

@github-actions
Copy link

github-actions bot commented Mar 16, 2022

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 67
🟢 Accessibility 100
🟢 Best practices 92
🟢 SEO 100
🟢 PWA 90

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

@github-actions
Copy link

github-actions bot commented Mar 16, 2022

Size Change: 0 B

Total Size: 792 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 599 kB
website/build/index.html 38.7 kB

compressed-size-action

@Josh-Cena Josh-Cena merged commit 8d1c195 into main Mar 16, 2022
@Josh-Cena Josh-Cena deleted the jc/blog-types branch March 16, 2022 11:36
@slorber
Copy link
Collaborator

slorber commented Mar 16, 2022

Yes that's nice 👍

That would be interested also if someday we'd be able to generate some API reference docs pages from those code types so that everything stays in sync

@Josh-Cena
Copy link
Collaborator Author

That would be interested also if someday we'd be able to generate some API reference docs pages from those code types so that everything stays in sync

Introducing Typedoc 😄 There's also a Docusaurus integration plugin which I can check out later

@Josh-Cena Josh-Cena added pr: polish This PR adds a very minor behavior improvement that users will enjoy. and removed pr: maintenance This PR does not produce any behavior differences to end users when upgrading. labels Mar 17, 2022
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: polish This PR adds a very minor behavior improvement that users will enjoy.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants