Skip to content

Commit 0831074

Browse files
Readme updates (#476)
* Removed a period. * Resolved hyperlink, by removing #- * Resoved bold text issue inside a details block, by changing ** to a <b> tag. * Resloved inline code section inside a details tag, by changing ` to <code>. * Capital letter. * Changed 'Robots / ROS' to 'Software'. This is aligned with the current Navbar buttons. * Added a spelling guide section.
1 parent e2181f7 commit 0831074

File tree

1 file changed

+37
-7
lines changed

1 file changed

+37
-7
lines changed

README.md

Lines changed: 37 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@
5050

5151
git clone https://github.com/clearpathrobotics/cpr-documentation.git
5252

53-
2. Create a branch from development. with a name indicating the purpose, such as _feature_xxxxxx_
53+
2. Create a branch from development with a name indicating the purpose, such as _feature_xxxxxx_
5454
3. Make changes to the relevant files.
55-
4. Test using your local server, using the steps mentioned [Steps to run this on your computer locally](##-steps-to-run-this-on-your-computer-locally)
55+
4. Test using your local server, using the steps mentioned [Steps to run this on your computer locally](#steps-to-run-this-on-your-computer-locally)
5656
5. When ready, enter `ctrl-c` in your terminal to stop the server. Then run `npm run build` to test that the site builds corretly.
5757
6. Resolve any errors that the terminal reports, and rerun the command `npm run build`.
5858
7. Finally, check that your updates adhere to our code formatting standard, by running the command `npm run format-check`.
@@ -129,18 +129,18 @@ When it is time to publish a numbered release of the user manual:
129129

130130
<br>
131131
Follow the steps for the OutdoorNav User Manual workflow above, replacing
132-
**outdoornav** with **indoornav**.
132+
<b>outdoornav</b> with <b>indoornav</b>.
133133

134134
</details>
135135

136-
## Workflow for publishing Robots / ROS User Manual updates
136+
## Workflow for publishing Software User Manual updates
137137

138138
<details>
139139

140-
<summary>Click to expand for details on how to update the Robots / ROS User Manual</summary>
140+
<summary>Click to expand for details on how to update the Software User Manual</summary>
141141

142142
<br>
143-
The Robots / ROS sections of the website are a "versioned" document called `docs`, which means that a snapshot of the content is
143+
The Software sections of the website are a "versioned" document called <code>docs</code>, which means that a snapshot of the content is
144144
made to align with each ROS version. This allows users to access version-specific copies of the
145145
documentation.
146146

@@ -217,7 +217,7 @@ includeCurrentVersion: false,
217217
HTML commenting—`<!-- -->`—causes issues with the MDX extension in VS Code.
218218
2. Refer to [Docusaurus's guide](https://docusaurus.io/docs/next/markdown-features) for supported Markdown features.
219219
3. For advanced users, refer to [Markdown MDX](https://mdxjs.com/) for adding React Components to a Markdown file.
220-
4. for advanced users, you may create React pages using _.js_ or _.ts_ file types.
220+
4. For advanced users, you may create React pages using _.js_ or _.ts_ file types.
221221

222222
## How should I name files?
223223

@@ -513,3 +513,33 @@ Even though the font size has been modified, the rendered diagram's font may not
513513
`}
514514
/>
515515
```
516+
517+
## Spelling Guide
518+
519+
Spelling on within this repository should align with the Government of Canada's [TERMIUM Plus®](https://www.btb.termiumplus.gc.ca/).
520+
Industry terms should align with the related organization's preferred spelling.
521+
522+
<details>
523+
<summary>Click to expand spelling examples</summary>
524+
<table>
525+
<tr><th>Correct spelling</th><th>Mistake</th></tr>
526+
<tr><th>10</th><th>Ten</th></tr>
527+
<tr><th>2X</th><th>2x</th></tr>
528+
<tr><th>Aluminum</th><th>Aluminium</th></tr>
529+
<tr><th>Antennas</th><th>Antennae</th></tr>
530+
<tr><th>Antennas</th><th>Aerial</th></tr>
531+
<tr><th>AWS, or Amazon Web Services</th><th>Amazon AWS</th></tr>
532+
<tr><th>Colour</th><th>Color</th></tr>
533+
<tr><th>Computer</th><th>PC</th></tr>
534+
<tr><th>Enable Switch</th><th>Deadman Switch</th></tr>
535+
<tr><th>Emergency Stop</th><th>E-stop</th></tr>
536+
<tr><th>GitHub</th><th>Github</th></tr>
537+
<tr><th>Lidar</th><th>LiDAR</th></tr>
538+
<tr><th>Metre</th><th>Meter</th></tr>
539+
<tr><th>ROS 2</th><th>ROS2</th></tr>
540+
<tr><th>RViz</th><th>Rviz</th></tr>
541+
<tr><th>Gmapping</th><th>gmapping</th></tr>
542+
<tr><th>Tire</th><th>Tyre</th></tr>
543+
<tr><th>Wi-Fi</th><th>wifi</th></tr>
544+
</table>
545+
</details>

0 commit comments

Comments
 (0)