Skip to content

[Docs] Link PR preview guide to canonical GitHub plugin pattern; refresh WP alias list - #3548

Merged
adamziel merged 1 commit into
trunkfrom
adamziel/docs-and-fatals
Apr 28, 2026
Merged

[Docs] Link PR preview guide to canonical GitHub plugin pattern; refresh WP alias list#3548
adamziel merged 1 commit into
trunkfrom
adamziel/docs-and-fatals

Conversation

@adamziel

@adamziel adamziel commented Apr 28, 2026

Copy link
Copy Markdown
Collaborator

Summary

Two small docs improvements to help LLMs set up the Playground preview button:

  1. Link to the canonical example of installing a plugin from a GitHub repo
  2. Refresh the preferredVersions.wp syntax, update the version range, use trunk as an example

No code changes.

Test plan

  • npm run build:docs renders both pages without broken anchors
  • The new link in the PR Preview guide resolves to the "Plugin in a GitHub repository" section
…; refresh WP alias list

Point readers from the PR Preview guide's Custom blueprints section to "Plugin in a GitHub repository," which already covers the git:directory pattern and the build-step caveat. Update the preferredVersions alias list in the data format reference to match what's actually accepted (latest, beta, nightly/trunk) and bump the WP version range to 6.3–6.9.
@adamziel
adamziel requested review from a team, bgrgicak and Copilot April 28, 2026 14:45
@github-actions github-actions Bot added the [Type] Documentation Improvements or additions to documentation label Apr 28, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates documentation to better cross-reference the canonical “GitHub plugin install” pattern and refreshes the WordPress version/alias guidance in the Blueprints data format reference.

Changes:

  • Add a one-line cross-link from PR Preview docs to the “Plugin in a GitHub repository” guidance.
  • Update preferredVersions.wp docs to include trunk aliasing and refresh the supported major-version range.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
packages/docs/site/docs/main/guides/github-action-pr-preview.md Adds a cross-link to the canonical plugin-from-GitHub installation pattern.
packages/docs/site/docs/blueprints/03-data-format.md Updates WordPress version/alias documentation for preferredVersions.wp.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread packages/docs/site/docs/main/guides/github-action-pr-preview.md
Comment thread packages/docs/site/docs/blueprints/03-data-format.md
@adamziel adamziel added the [Type] Enhancement New feature or request label Apr 28, 2026
@adamziel
adamziel merged commit c42488e into trunk Apr 28, 2026
47 checks passed
@adamziel
adamziel deleted the adamziel/docs-and-fatals branch April 28, 2026 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Documentation Improvements or additions to documentation [Type] Enhancement New feature or request

2 participants