You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
[Docs] Fix the Symfony snippet example and handbook screenshot links - #4686
While reviewing the pt-BR translations in #4679 and #4681, I found two issues in the English guides. The Symfony packaging example refers to a bundled ZIP, which an inline <php-snippet> cannot resolve. The GitHub contribution guide uses site-relative screenshot paths that the WordPress.org handbook importer cannot resolve.
Implementation details
Use the Symfony archive URL from the working embed in the packaging example. The Blueprint extracts the app into /app. Full-page demos can use the router described below the example.
Explain when a Blueprint bundle can use a relative ZIP path.
Link the three GitHub editor screenshots directly to their committed WebP files and document that convention for contributors.
Testing Instructions (or ideally a Blueprint)
Use the JSON from Package the app as a ZIP as the Blueprint for the guide’s Try a Symfony app snippet. Run it with wp="none" and confirm the output below.
Open the three screenshot links in Contribute with the GitHub web interface and confirm that they show the file editor, file creation, and Markdown editor.
HTTP 200
Symfony page: Symfony Playground
WordPress installed: no
Verified locally with PHP 8.4 WebAssembly using the archive downloaded from the documented URL. Both pages compiled with the Docusaurus MDX loader. All three downloaded images matched the committed files byte for byte.
Summary by CodeRabbit
Documentation
Updated the GitHub editing guide to clarify that its Markdown preview may differ from the handbook and to use raw URLs for committed screenshots.
Revised the Blueprint example to use a hosted ZIP URL and explain how to reference a ZIP bundled with the Blueprint.
No actionable comments were generated in the recent review.
Walkthrough
The GitHub editing guide updates screenshot links and review instructions. The PHP framework guide changes a Blueprint example and explains how to specify hosted and bundled ZIP resources.
Changes: GitHub editing guide
Layer / File(s)
Summary
Screenshot links and review guidance packages/docs/site/docs/main/contributing/github-ui.md
Screenshot links now use raw GitHub URLs. The guidance covers checking links and images, GitHub Markdown preview limitations, and using committed screenshots in the WordPress.org handbook.
PHP framework guide
Layer / File(s)
Summary
Blueprint example and resource guidance packages/docs/site/docs/main/guides/php-frameworks.md
The example removes landingPage and uses a hosted ZIP URL. The text explains URL fetching for inline snippets and relative bundled paths when the ZIP is distributed with blueprint.json.
This updates the Symfony example and the screenshot links in the contribution guide. It changes documentation only, so merge risk is minimal.
Pre-merge checks: 4
Check name
Status
Explanation
Description Check
Check skipped - CodeRabbit’s high-level summary is enabled.
Title check
The title "[Docs] Fix the Symfony snippet example and handbook screenshot links" matches the main changes. The PR edits the Symfony Blueprint example in php-frameworks.md, which removes landingPage an…
Linked Issues check
Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check
Check skipped because no linked issues were found for this pull request.
Full details: Title check
Explanation
The title "[Docs] Fix the Symfony snippet example and handbook screenshot links" matches the main changes. The PR edits the Symfony Blueprint example in php-frameworks.md, which removes landingPage and switches the ZIP source to a hosted URL. It also changes github-ui.md so the three editor screenshots link to committed raw URLs. The title is specific, concise, and in one sentence, so it clearly describes the primary change.
Finishing Touches
Generate unit tests (beta)
Create a new PR
Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.
This branch has not been deployed
No deployments
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
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 for the change, related issues
While reviewing the pt-BR translations in #4679 and #4681, I found two issues in the English guides. The Symfony packaging example refers to a bundled ZIP, which an inline
<php-snippet>cannot resolve. The GitHub contribution guide uses site-relative screenshot paths that the WordPress.org handbook importer cannot resolve.Implementation details
/app. Full-page demos can use the router described below the example.Testing Instructions (or ideally a Blueprint)
wp="none"and confirm the output below.Verified locally with PHP 8.4 WebAssembly using the archive downloaded from the documented URL. Both pages compiled with the Docusaurus MDX loader. All three downloaded images matched the committed files byte for byte.
Summary by CodeRabbit