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: refactor & refine lifecycle API docs #5918

Merged
merged 11 commits into from
Dec 21, 2021
Merged

Conversation

Josh-Cena
Copy link
Collaborator

Motivation

The lifecycle API doc is becoming more and more cluttered overtime, and the name is also somehow misleading since there are other non-lifecycle APIs. I wish to more formally introduce their usage.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Nov 10, 2021
@Josh-Cena Josh-Cena marked this pull request as draft November 10, 2021 09:18
@Josh-Cena Josh-Cena added the pr: documentation This PR works on the website or other text documents in the repo. label Nov 10, 2021
@netlify
Copy link

netlify bot commented Nov 10, 2021

✔️ [V2]

🔨 Explore the source changes: b6bdfa9

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

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

@github-actions
Copy link

github-actions bot commented Nov 10, 2021

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 50
🟢 Accessibility 98
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

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

@slorber
Copy link
Collaborator

slorber commented Nov 10, 2021

👍 looks like a nice idea

Not so easy to categorize properly all these apis.

Maybe we should rename "lifecycle API" to just "plugin apis"?

We'll likely need a redirect in _redirects

@Josh-Cena
Copy link
Collaborator Author

Josh-Cena commented Nov 10, 2021

Maybe we should rename "lifecycle API" to just "plugin apis"?

That's exactly what I plan to do:P https://deploy-preview-5918--docusaurus-2.netlify.app/docs/api/plugin-methods/

We'll likely need a redirect in _redirects

Since we already marked the section as WIP—won't that imply there can be any kind of breaking changes?

@Josh-Cena Josh-Cena marked this pull request as ready for review December 19, 2021 08:07
@Josh-Cena Josh-Cena added status: awaiting review This PR is ready for review, will be merged after maintainers' approval and removed status: awaiting review This PR is ready for review, will be merged after maintainers' approval labels Dec 19, 2021
@Josh-Cena Josh-Cena added the status: awaiting review This PR is ready for review, will be merged after maintainers' approval label Dec 19, 2021
@github-actions
Copy link

github-actions bot commented Dec 19, 2021

Size Change: +5.38 kB (+1%)

Total Size: 658 kB

Filename Size Change
website/.docusaurus/globalData.json 39.3 kB +1.53 kB (+4%)
website/build/assets/js/main.********.js 487 kB +3.85 kB (+1%)
ℹ️ View Unchanged
Filename Size
website/build/assets/css/styles.********.css 101 kB
website/build/index.html 29.6 kB

compressed-size-action

@Josh-Cena Josh-Cena removed the status: awaiting review This PR is ready for review, will be merged after maintainers' approval label Dec 21, 2021
@Josh-Cena Josh-Cena merged commit 9078fd9 into main Dec 21, 2021
@Josh-Cena Josh-Cena deleted the jc/refactor-plugin-docs branch December 21, 2021 06:54
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