-
-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
Conversation
bfcac0e
to
9a35e67
Compare
✔️ [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 |
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5918--docusaurus-2.netlify.app/ |
👍 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 |
That's exactly what I plan to do:P https://deploy-preview-5918--docusaurus-2.netlify.app/docs/api/plugin-methods/
Since we already marked the section as WIP—won't that imply there can be any kind of breaking changes? |
089c8c8
to
5de6c6c
Compare
Size Change: +5.38 kB (+1%) Total Size: 658 kB
ℹ️ View Unchanged
|
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