docs(v2): document plugins and lifecycle APIs#1724
Conversation
|
Deploy preview for docusaurus-2 ready! Built with commit 8caa20a |
|
Deploy preview for docusaurus-preview ready! Built with commit 8caa20a |
website/docs/advanced-plugins.md
Outdated
|
|
||
| A plugin is a module which exports a function that takes two parameters and returns an object. | ||
|
|
||
| We need to specify for our plugin: |
There was a problem hiding this comment.
These are not the only things a plugin is for. Only content plugins do these, the rest don't have to do so. I think saying this can be misleading for people unfamiliar to the concept of plugins.
website/docs/advanced-plugins.md
Outdated
|
|
||
| And `options` are optionally the [second parameter when the plugins are used](/docs/using-plugins#configuring-plugins). | ||
|
|
||
| ### Paths to watch |
There was a problem hiding this comment.
I wonder why we only mention paths to watch here? Is this supposed to be a tutorial or some sort?
|
@wgao19 Will you follow up on the PR? Or I could take over too. |
|
Hi @yangshun yes plz help take over this. I am still pretty held up by my work stuff recently :( |
yangshun
force-pushed
the
wgao19/docs-lifecycle-apis
branch
from
fdde3df to
3ec8e90
Compare
yangshun
changed the title
yangshun
left a comment
yangshun
left a comment
There was a problem hiding this comment.
Proofread and edited, of course I approve of my own work 😄
|
@endiliey wanna have a go at reviewing it? |
5 participants
Motivation
Addressing #1640, refine docs to lifecycle APIs. Might combine to refine docs on advanced guides on plugins as well.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)
NA
Related PRs
NA