Skip to content

Standardize Numbering Format in Documentation for "Build the Source" …#187

Open
flechemano wants to merge 1 commit intoartela-network:mainfrom
flechemano:patch-1
Open

Standardize Numbering Format in Documentation for "Build the Source" …#187
flechemano wants to merge 1 commit intoartela-network:mainfrom
flechemano:patch-1

Conversation

@flechemano
Copy link
Copy Markdown

…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"

  1. 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.

…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 <flechemano@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant