rockydocs_formatting.md #2990
Merged
rockydocs_formatting.md #2990
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
Grammar check
sspencerwire
reviewed
Nov 3, 2025
| === "9" | ||
|
|
||
| Use this procedure if your installation was by way of the full operating system, or from a Live image. | ||
| Use this procedure if your installation was performed using the whole operating system or a Live image. |
Contributor
There was a problem hiding this comment.
"was performed" here introduces passive voice. There may be another way to better reword this.
sspencerwire
reviewed
Nov 3, 2025
| ``` | ||
|
|
||
| Remember that everything that falls inside of the section must continue to use the 4-space indentation until completion of the section. This is a very handy feature! | ||
| Just to remind you, everything within the section must continue to use 4-space indentation until the section is completed. This is a convenient feature! |
Contributor
There was a problem hiding this comment.
"is completed" also passive voice.
sspencerwire
reviewed
Nov 3, 2025
| There are times when a simple ++enter++ on the keyboard will not give you a new line in markdown. This sometimes occurs when bulleted items use a lot of formatting characters. You may want to add a line break to better format text as well. In cases like these, you need to add two spaces to the end of the line where you want a new line. Since spaces will not be visible in some markdown editors, this example shows the spaces being entered: | ||
| There are times when a simple ++enter++ on the keyboard will not give you a new line in markdown. This sometimes occurs when bulleted items contain many formatting characters. I suggest adding a line break to better format text as well. In cases like these, you need to add two spaces to the end of the line where you want a new line. Since spaces will not be visible in some markdown editors, this example shows the spaces being entered: | ||
Contributor
There was a problem hiding this comment.
I try to avoid "I" and "we" in writing documentation and switch to "you" and "your" where possible. This is suggested by Vale too, so it isn't just me. :-)
Some rewording
sspencerwire
approved these changes
Nov 3, 2025
Test results for 8ed4196:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Grammar check
Author checklist (Completed by original Author)
Rocky Documentation checklist (Completed by Rocky team)