docs: harmonize top-level README with plugin README#1446
Merged
Conversation
Resolve drift uncovered during the v5.0.2 release scrub. Both READMEs and the demo intro page should describe the same plugin surface. - Top-level README: add the missing `Supported Vendor Extensions` section (table + ignored-extensions paragraph), the `x-position` hint under `sidebarOptions`, the `maskCredentials` example-config line, and the `Extensible` Key Feature bullet. Move the `maskCredentials` row up next to `showExtensions` so related rendering toggles sit together. - Plugin README: add the `Extensible` Key Feature bullet and linkify `@bourdakos1` to match the top-level README. `demo/docs/intro.mdx` already had this content and is unchanged.
|
Size Change: 0 B Total Size: 2.26 MB ℹ️ View Unchanged
|
|
Visit the preview URL for this PR (updated for commit a78ea9a): https://docusaurus-openapi-36b86--pr1446-ptrd0pxq.web.app (expires Fri, 08 May 2026 19:35:17 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: bf293780ee827f578864d92193b8c2866acd459f |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Resolves drift between the top-level `README.md` and `packages/docusaurus-plugin-openapi-docs/README.md` that was uncovered during the v5.0.2 release scrub. The plugin README and `demo/docs/intro.mdx` were both ahead of the top-level README on a few items; this PR brings the top-level back in sync.
Top-level `README.md`
`packages/docusaurus-plugin-openapi-docs/README.md`
`demo/docs/intro.mdx` already had the Vendor Extensions section and Extensible bullet — no changes there.
After this PR the only remaining differences between the top-level and plugin READMEs are intentional (the top-level tagline mentions "Docusaurus Faster" compatibility, and the hero screenshots differ).
Test plan