Open
Conversation
…PIs and caution regarding the demo site. Removed outdated fragments and improved API descriptions for better user guidance.
…s. Added caution regarding the demo site's reliability and removed outdated fragments. Enhanced API descriptions for better user guidance.
…aution about demo site reliability, improving API descriptions, and removing outdated fragments. Clarified usage of Query API across multiple sections.
…consistency across multiple languages. Improved descriptions of the Query API and streamlined navigation sections. Removed outdated fragments and ensured all links are functional.
…istency across multiple languages. Added caution regarding the demo site's reliability, enhanced descriptions of the Query API, and removed outdated fragments. Streamlined navigation sections for better user experience.
Contributor
There was a problem hiding this comment.
Pull request overview
Removes MD/MDX fragment imports from the docs (including localized copies) and inlines the fragment content directly to better align with the WordPress.org handbook tooling.
Changes:
- Replaced fragment imports (API list, Query API callout, demo-site caution, JS short example) with inlined Markdown/MDX content across docs.
- Deleted fragment files that are no longer referenced.
- Applied the same inlining approach across multiple locales.
Reviewed changes
Copilot reviewed 35 out of 35 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/docs/site/i18n/tl/docusaurus-plugin-content-docs/current/main/quick-start-guide.md | Inlines the “ThisIsQueryApi” callout text |
| packages/docs/site/i18n/tl/docusaurus-plugin-content-docs/current/main/intro.md | Replaces API list fragment with an inlined API list |
| packages/docs/site/i18n/pt-BR/docusaurus-plugin-content-docs/current/main/quick-start-guide.md | Inlines the “ThisIsQueryApi” callout text |
| packages/docs/site/i18n/pt-BR/docusaurus-plugin-content-docs/current/main/intro.md | Replaces API list fragment with an inlined API list |
| packages/docs/site/i18n/pt-BR/docusaurus-plugin-content-docs/current/developers/06-apis/javascript-api/01-index.md | Inlines the short JavaScript API HTML example |
| packages/docs/site/i18n/pt-BR/docusaurus-plugin-content-docs/current/developers/03-build-an-app/01-index.md | Inlines demo-site caution + API list + Query API callout |
| packages/docs/site/i18n/pt-BR/docusaurus-plugin-content-docs/current/_fragments/_work_in_progress.md | Deletes unused fragment |
| packages/docs/site/i18n/pt-BR/docusaurus-plugin-content-docs/current/_fragments/_this_is_query_api.md | Deletes unused fragment |
| packages/docs/site/i18n/pt-BR/docusaurus-plugin-content-docs/current/_fragments/_playground_wp_net_may_stop_working.md | Deletes unused fragment |
| packages/docs/site/i18n/pt-BR/docusaurus-plugin-content-docs/current/_fragments/_api_list.mdx | Deletes unused fragment |
| packages/docs/site/i18n/ja/docusaurus-plugin-content-docs/current/main/quick-start-guide.md | Inlines the “ThisIsQueryApi” callout text |
| packages/docs/site/i18n/ja/docusaurus-plugin-content-docs/current/main/intro.md | Replaces API list fragment with an inlined API list |
| packages/docs/site/i18n/ja/docusaurus-plugin-content-docs/current/developers/06-apis/javascript-api/01-index.md | Inlines the short JavaScript API HTML example |
| packages/docs/site/i18n/ja/docusaurus-plugin-content-docs/current/developers/06-apis/01-index.md | Inlines Query API callout, JS example, demo-site caution, and API list |
| packages/docs/site/i18n/ja/docusaurus-plugin-content-docs/current/developers/03-build-an-app/01-index.md | Inlines demo-site caution + API list + Query API callout |
| packages/docs/site/i18n/gu/docusaurus-plugin-content-docs/current/main/quick-start-guide.md | Inlines the “ThisIsQueryApi” callout text |
| packages/docs/site/i18n/gu/docusaurus-plugin-content-docs/current/main/intro.md | Replaces API list fragment with an inlined API list |
| packages/docs/site/i18n/fr/docusaurus-plugin-content-docs/current/main/quick-start-guide.md | Inlines the “ThisIsQueryApi” callout text |
| packages/docs/site/i18n/fr/docusaurus-plugin-content-docs/current/main/intro.md | Inlines API list and adjusts formatting/comment blocks |
| packages/docs/site/i18n/fr/docusaurus-plugin-content-docs/current/developers/03-build-an-app/01-index.md | Inlines demo-site caution + API list + Query API callout |
| packages/docs/site/i18n/es/docusaurus-plugin-content-docs/current/main/quick-start-guide.md | Inlines the “ThisIsQueryApi” callout text |
| packages/docs/site/i18n/es/docusaurus-plugin-content-docs/current/main/intro.md | Replaces API list fragment with an inlined API list |
| packages/docs/site/i18n/es/docusaurus-plugin-content-docs/current/developers/03-build-an-app/01-index.md | Inlines demo-site caution + API list + Query API callout |
| packages/docs/site/i18n/bn/docusaurus-plugin-content-docs/current/main/quick-start-guide.md | Inlines the “ThisIsQueryApi” callout text |
| packages/docs/site/i18n/bn/docusaurus-plugin-content-docs/current/main/intro.md | Replaces API list fragment with an inlined API list |
| packages/docs/site/docs/main/quick-start-guide.md | Inlines the “ThisIsQueryApi” callout text |
| packages/docs/site/docs/main/intro.md | Replaces API list fragment with an inlined API list |
| packages/docs/site/docs/developers/06-apis/javascript-api/01-index.md | Inlines the short JavaScript API HTML example |
| packages/docs/site/docs/developers/06-apis/01-index.md | Inlines Query API callout, JS example, demo-site caution, and API list |
| packages/docs/site/docs/developers/03-build-an-app/01-index.md | Inlines demo-site caution + API list + Query API callout |
| packages/docs/site/docs/_fragments/_work_in_progress.md | Deletes unused fragment |
| packages/docs/site/docs/_fragments/_this_is_query_api.md | Deletes unused fragment |
| packages/docs/site/docs/_fragments/_playground_wp_net_may_stop_working.md | Deletes unused fragment |
| packages/docs/site/docs/_fragments/_js_api_short_example.mdx | Deletes unused fragment |
| packages/docs/site/docs/_fragments/_api_list.mdx | Deletes unused fragment |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
packages/docs/site/i18n/fr/docusaurus-plugin-content-docs/current/main/intro.md
Outdated
Show resolved
Hide resolved
...ite/i18n/pt-BR/docusaurus-plugin-content-docs/current/developers/03-build-an-app/01-index.md
Show resolved
Hide resolved
packages/docs/site/i18n/pt-BR/docusaurus-plugin-content-docs/current/main/intro.md
Outdated
Show resolved
Hide resolved
...ages/docs/site/i18n/ja/docusaurus-plugin-content-docs/current/developers/06-apis/01-index.md
Outdated
Show resolved
Hide resolved
packages/docs/site/i18n/tl/docusaurus-plugin-content-docs/current/main/quick-start-guide.md
Outdated
Show resolved
Hide resolved
…ated fragments and improving clarity. Adjusted comment syntax for better readability and streamlined navigation sections.
…ent/developers/06-apis/01-index.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ent/main/quick-start-guide.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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
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.
This pull request removes the fragments to ensure compatibility with the .org script handbook.
APIList,ThisIsQueryApi,PlaygroundWpNetWarning, andJSApiShortExamplefrom documentation files, replacing them with inlined content for API lists, caution messages, and code examples. This streamlines the documentation and reduces indirection. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21]Content clarity and accessibility:
playground.wordpress.netare now directly embedded in the relevant docs, improving visibility for users. [1] [2] [3] [4]Translation and localization:
bn) and Spanish (es) documentation, ensuring consistency across languages. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11]General cleanup:
These changes make the documentation more self-contained, easier to maintain, and more user-friendly for both English and translated versions.