Standardize Numbering Format in Documentation for "Build the Source" … #187
Conversation
This file contains 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
…Section.md The "Build the Source" section in the documentation currently uses "1)", "2)", ... for numbering steps. To improve consistency and follow standard practices in technical documentation, the numbering format should be updated to **"1.", "2.", ...". Steps to Reproduce: 1. Open the documentation page containing the "Build the Source" section. 2. Locate the steps under the subsections: "Set Up Your Go Development Environment" "Download the Source Code" "Compile" 3. Observe the numbering format, which currently uses "1)", "2)", "3)", etc. Proposed Solution: Change the numbering format from "1)", "2)", ... to "1.", "2.", "3.", ... for all steps. Example: Current: 1). Set Up Your Go Development Environment 2). Download the Source Code Proposed: 1. Set Up Your Go Development Environment 2. Download the Source Code Benefits of the Update: Follows conventional technical documentation practices. Improves readability and professionalism. Maintains consistency with other documentation styles. Signed-off-by: oktay Aslan <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
…Section.md
The "Build the Source" section in the documentation currently uses "1)", "2)", ... for numbering steps. To improve consistency and follow standard practices in technical documentation, the numbering format should be updated to **"1.", "2.", ...".
Steps to Reproduce:
Open the documentation page containing the "Build the Source" section.
Locate the steps under the subsections:
"Set Up Your Go Development Environment"
"Download the Source Code"
"Compile"
Proposed Solution:
Change the numbering format from "1)", "2)", ... to "1.", "2.", "3.", ... for all steps.
Example:
Current:
1). Set Up Your Go Development Environment
2). Download the Source Code
Proposed:
Benefits of the Update:
Follows conventional technical documentation practices.
Improves readability and professionalism.
Maintains consistency with other documentation styles.