docs: try to make plugin/preset config less confusing #5313
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
slorber
added
the
pr: documentation
|
✔️ [V2] 🔨 Explore the source changes: 85fd0a9 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/610d77d7fcbfd000073dbe26 😎 Browse the preview: https://deploy-preview-5313--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5313--docusaurus-2.netlify.app/ |
|
Size Change: -2 B (0%) Total Size: 792 kB ℹ️ View Unchanged
|
|
@lex111 @Josh-Cena any opinion on this doc structure? |
|
@slorber looks good to me, that's much better! |
|
@slorber LGTM! |
|
thanks 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
Make it easier to understand that there are 2 ways to configure content plugins, and most users should use the preset config.
See confusion here: #5246 (comment)
Preview: https://deploy-preview-5313--docusaurus-2.netlify.app/docs/next/api/plugins/@docusaurus/plugin-content-docs/