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
In "The Codespace Environment", the sentence about codespace-details.txt is missing a preposition ("credentials access"); consider rephrasing to improve readability.
Once the setup is complete, you will be in a Visual Studio Code environment within your browser. A file named `codespace-details.txt` will be available,
containing all the necessary credentials access the Joomla installation.
Verify that the "Code" button and "Create codespace" option accurately reflect current GitHub UI for PR pages; wording might need to specify "Code" dropdown on the repository/PR and "Create codespace on main/branch".
1. Navigate to the pull request you want to test on GitHub.
2. Click the **Code** button in the top right.
3. Select the **Create codespace** option.
4. A new browser tab will open, and GitHub will begin creating the Codespace. This process will take a few minutes as it sets up the entire Joomla
Consider adding notes on resource limits/timeouts of Codespaces, cost implications, and persistence (e.g., how to resume a stopped codespace) to set tester expectations.
## The Codespace Environment
Once the setup is complete, you will be in a Visual Studio Code environment within your browser. A file named `codespace-details.txt` will be available,
containing all the necessary credentials access the Joomla installation.

The new docs reference multiple screenshots under _assets/, but the PR doesn’t include those assets nor confirm their path relative to the docs build system. Ensure all images are added to the repo and that paths comply with the docs site’s static asset conventions, otherwise the guide will ship with broken images.
# In docs/testing/manually/github-codespaces.md
...
3. Select the **Create codespace** option.

...
# PR does not include the image file:# _assets/create-github-codespace.png
After:
# In docs/testing/manually/github-codespaces.md
...
3. Select the **Create codespace** option.

...
# PR should also add the image files, for example:# + /docs/testing/manually/_assets/create-github-codespace.png# + /docs/testing/manually/_assets/initial-vscode-setup.png# ... and all other images
Suggestion importance[1-10]: 9
__
Why: This suggestion correctly identifies a critical issue where referenced images are missing from the PR, which would result in broken content in the new documentation page.
High
General
✅ Use stable absolute linkSuggestion Impact:The commit updated the relative link ./github-codespaces.md to the absolute path /testing/manually/github-codespaces as suggested.
code diff:
-For a step-by-step guide, please see the **[Testing PRs with GitHub Codespaces](./github-codespaces.md)** documentation.+For a step-by-step guide, please see the **[Testing PRs with GitHub Codespaces](/testing/manually/github-codespaces)** documentation.
Use an absolute docs link to ensure the reference resolves correctly in all build contexts and avoid broken links if this file moves. This prevents navigation errors.
-For a step-by-step guide, please see the **[Testing PRs with GitHub Codespaces](./github-codespaces.md)** documentation.+For a step-by-step guide, please see the **[Testing PRs with GitHub Codespaces](/testing/manually/github-codespaces)** documentation.
[Suggestion processed]
Suggestion importance[1-10]: 7
__
Why: The suggestion correctly proposes changing a relative link to an absolute one, which is a best practice for documentation maintainability and helps prevent broken links if files are moved.
Medium
✅ Clarify port naming and URLSuggestion Impact:The commit updated the documentation text to generalize port names and specify clicking the HTTP(S) forwarded URL, matching the suggested clarification.
code diff:
-To access these, navigate to the **Ports** tab in VS Code. You will find forwarded ports for the Web Server and Cypress GUI. Click the -globe icon next to the "Web Server" to open the Joomla site in a new tab.+To access these, navigate to the **Ports** tab in VS Code. You will find forwarded ports (e.g., "Web Server", "Cypress"). Click the globe icon next to the HTTP(S) forwarded URL for the web server to open the Joomla site in a new tab.
Clarify that ports may be labeled differently and ensure the user opens the correct forwarded URL (HTTPS) to avoid mixed-content or blocked popups. This reduces user confusion when port names differ.
-To access these, navigate to the **Ports** tab in VS Code. You will find forwarded ports for the Web Server and Cypress GUI. Click the -globe icon next to the "Web Server" to open the Joomla site in a new tab.+To access these, navigate to the **Ports** tab in VS Code. You will find forwarded ports (e.g., "Web Server", "Cypress"). Click the globe icon next to the HTTP(S) forwarded URL for the web server to open the Joomla site in a new tab.
[Suggestion processed]
Suggestion importance[1-10]: 6
__
Why: The suggestion improves the documentation by making the instructions for accessing forwarded ports more generic and robust, which helps prevent user confusion if port labels change in the future.
Low
✅ Fix grammatical claritySuggestion Impact:The commit added "to" in the sentence, changing "credentials access" to "credentials to access," exactly as suggested.
code diff:
Once the setup is complete, you will be in a Visual Studio Code environment within your browser. A file named `codespace-details.txt` will be available,
-containing all the necessary credentials access the Joomla installation.+containing all the necessary credentials to access the Joomla installation.
Fix the grammatical error to clarify that the credentials are used to access the Joomla installation. This improves readability and prevents confusion for users following the steps.
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.
User description
This is the documentation PR for joomla/joomla-cms#45719
PR Type
Documentation
Description
Add comprehensive GitHub Codespaces documentation for testing
Include step-by-step setup and usage guide
Update main testing index with Codespaces option
Provide screenshots and detailed environment instructions
Diagram Walkthrough
File Walkthrough
github-codespaces.md
New GitHub Codespaces testing documentationdocs/testing/manually/github-codespaces.md
index.md
Update testing index with Codespaces optiondocs/testing/manually/index.md