Fixes for mixed issues I found #4407
Draft
+19
−14
Conversation
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
The wording on the preface page does not match what we have on the left hand side natigation menu.
There was a problem hiding this comment.
Pull Request Overview
This PR updates documentation and navigation references across the Reference and Installation/Upgrade guides, and records the changes in the changelog.
- Add Antora-compatible xref syntax (with []) to System Details links
- Update revdates for affected pages
- Update Installation/Upgrade overview section names and add corresponding changelog entries
Reviewed Changes
Copilot reviewed 3 out of 6 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| modules/reference/pages/systems/system-details/sd-details.adoc | Fix xref links by adding [] for proper Antora rendering and update revdate |
| modules/installation-and-upgrade/pages/installation-and-upgrade-overview.adoc | Adjust section names for clarity/consistency and update revdate |
| CHANGELOG.md | Add entries describing the documentation fixes and updates |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| @@ -1,3 +1,8 @@ | |||
| - Updated the admin_* screenshots in multiple sections | |||
| - Aligned the preface section to match the navigation in | |||
| Installation and Upgrade Guide | |||
There was a problem hiding this comment.
Grammar: add the definite article. It should read 'in the Installation and Upgrade Guide.'
Suggested change
| Installation and Upgrade Guide | |
| the Installation and Upgrade Guide |
Copilot uses AI. Check for mistakes.
| - Aligned the preface section to match the navigation in | ||
| Installation and Upgrade Guide | ||
| - Fixed the broken references for the system details pages | ||
| in Reference Guide |
There was a problem hiding this comment.
Grammar: add the definite article. It should read 'in the Reference Guide.'
Suggested change
| in Reference Guide | |
| in the Reference Guide |
Copilot uses AI. Check for mistakes.
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.
Description
This PR includes fixes for some issues I found while taking a look at the documentation. Each fix is put into its own commit with a changelog entry. Please take a look at the commits.
Examples
Target branches