Skip to content

Commit 0c62ae2

Browse files
jhiggins-cprjhiggins-cpr
authored
Merge pull request #450 from clearpathrobotics/development
Merge development to production
2 parents 5dfc9f5 + 30b5023 commit 0c62ae2

File tree

463 files changed

+32454
-30927
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

463 files changed

+32454
-30927
lines changed

‎.gitattributes‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Files determined by git to be text files
2+
# are automatically normalized to LF line endings.
3+
* text=auto eol=lf
4+
# The following files are explicitly set to use LF line endings.
5+
*.mdx eol=lf
6+
*.md eol=lf
7+
*.json eol=lf
8+
9+
# If there are files which are generated with CRLF line endings,
10+
# it is recommended to set them to CRLF so that there is no unnecessary
11+
# diff when regenerating them.
12+
13+
# The binary macro is equivalent to the following:
14+
# -text -diff
15+
# Which means that line endings are not normalized and no diff is generated.
16+
*.jpg binary
17+
*.png binary
18+
*.gif binary
19+
*.mp4 binary

‎CODEOWNERS‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
# Default all changes will request review from:
2-
* @rhysfaultless-cpr @jhiggins-cpr @tonybaltovski @hilary-luo
1+
# Default all changes will request review from:
2+
* @rhysfaultless-cpr @jhiggins-cpr @tonybaltovski @hilary-luo

‎LICENSE‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
MIT License
2-
3-
Copyright (c) 2022-2023 Clearpath Robotics Inc.
4-
5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
11-
12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
14-
15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
1+
MIT License
2+
3+
Copyright (c) 2022-2023 Clearpath Robotics Inc.
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -63,12 +63,14 @@
6363
You can fix the errors by running Prettier on a single file, with `npx prettier --write <FILE PATH>`.
6464
For example, you can run the command `npx prettier --write README.md` to format this README.
6565

66+
If you have added a new folder and need to format all files within it you can use the `*` wildcard, for example" `npx prettier --write folder/*`
67+
6668
- Refer to the _package.json_ to understand what this script calls.
6769
- Refer to the _.prettierrc.json_ to understand the rules Prettier is using when checking files.
6870

6971
Note, we used to suggest the command `npm run format-write` to update all the files in this repository.
7072
We don't suggest this command anymore, since it is then difficult for reviewers of Pull Requests to find the intended content changes.
71-
If you do continue to use this entire repositry command, you may see files that claim to be updated in Source Control, but don't have any visible changes.
73+
If you do continue to use this entire repository command, you may see files that claim to be updated in Source Control, but don't have any visible changes.
7274
If so, you should run these commands in your terminal to prevent Git from noting these types of changes:
7375

7476
git config --global core.filemode false
@@ -254,21 +256,20 @@ This helps Users know where they downloaded the file from later, as the asset is
254256
In an `img/` folder next to the markdown files where it will be used.
255257

256258
6. Files larger than 100 MB
257-
259+
258260
Files added to GitHub must be smaller than 100 MB—_(at time of writing in 2025-04)_.
259261
You will be able to commit a large file locally, but the push to GitHub will fail.
260262
We are storing large files in an Amazon S3 Bucket, rather than the cpr-documentation repository's `/static/assets` directory.
261263
Note that this means large files will need to be added by Clearpath Robotics staff, as we do not provide public access to this S3 Bucket.
262264

263265
To add a file:
264266

265-
* Sign into https://us-east-2.console.aws.amazon.com/s3/ .
266-
* Navigate to the S3 Bucket `cpr-documentation-large-files `.
267-
* Select the `Upload` button, and choose your local file.
268-
* After the file has been uploaded, click on the new object, and copy its `Object URL`.
267+
- Sign into https://us-east-2.console.aws.amazon.com/s3/ .
268+
- Navigate to the S3 Bucket `cpr-documentation-large-files `.
269+
- Select the `Upload` button, and choose your local file.
270+
- After the file has been uploaded, click on the new object, and copy its `Object URL`.
269271
This is the public URL to access the file you uploaded.
270272
Note that this S3 Bucket is configured so all files' permissions are automatically set to public access.
271-
272273

273274
## How to merge branches into the Production branch?
274275

‎components/button_download.module.css‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
.buttons {
2-
display: flex;
3-
align-items: center;
4-
justify-content: center;
1+
.buttons {
2+
display: flex;
3+
align-items: center;
4+
justify-content: center;
55
}

‎components/button_download_step.tsx‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
import styles from "./button_download.module.css";
2-
3-
export default function ButtonStepDownload(props) {
4-
return(
5-
<div>
6-
<div className={styles.buttons}>
7-
<a className="button button--secondary button--lg" href={props.filePath}>Download STEP Model Of The Robot</a>
8-
</div>
9-
<br/>
10-
</div>
11-
)
12-
}
1+
import styles from "./button_download.module.css";
2+
3+
export default function ButtonStepDownload(props) {
4+
return(
5+
<div>
6+
<div className={styles.buttons}>
7+
<a className="button button--secondary button--lg" href={props.filePath}>Download STEP Model Of The Robot</a>
8+
</div>
9+
<br/>
10+
</div>
11+
)
12+
}

‎components/button_download_wiring_diagram.tsx‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
import styles from "./button_download.module.css";
2-
3-
export default function ButtonDownload(props) {
4-
return(
5-
<div>
6-
<div className={styles.buttons}>
7-
<a className="button button--secondary button--lg" href={props.filePath} target="_blank">Download The Robot's Wiring Diagram</a>
8-
</div>
9-
<br/>
10-
</div>
11-
)
12-
}
1+
import styles from "./button_download.module.css";
2+
3+
export default function ButtonDownload(props) {
4+
return(
5+
<div>
6+
<div className={styles.buttons}>
7+
<a className="button button--secondary button--lg" href={props.filePath} target="_blank">Download The Robot's Wiring Diagram</a>
8+
</div>
9+
<br/>
10+
</div>
11+
)
12+
}

‎components/common_lighting_states_estop_reset_operational.mdx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
<div class="table-container-for-centering">
2-
<div class="centred-table">
3-
| Lighting State | Lighting Pattern |
4-
| :----------------------------------- | :--------------------------------------------------------------------------------------: |
5-
| Emergency Stop | <img src="/img/robot_images/common_images/lighting_images/stopped.gif" width="100"/> |
6-
| Needs Reset _(after Emergency Stop)_ | <img src="/img/robot_images/common_images/lighting_images/needs_reset.gif" width="100"/> |
7-
| Operational _(Driving or Idle)_ | <img src="/img/robot_images/common_images/lighting_images/driving.png" width="100"/> |
8-
</div>
9-
</div>
1+
<div class="table-container-for-centering">
2+
<div class="centred-table">
3+
| Lighting State | Lighting Pattern |
4+
| :----------------------------------- | :--------------------------------------------------------------------------------------: |
5+
| Emergency Stop | <img src="/img/robot_images/common_images/lighting_images/stopped.gif" width="100"/> |
6+
| Needs Reset _(after Emergency Stop)_ | <img src="/img/robot_images/common_images/lighting_images/needs_reset.gif" width="100"/> |
7+
| Operational _(Driving or Idle)_ | <img src="/img/robot_images/common_images/lighting_images/driving.png" width="100"/> |
8+
</div>
9+
</div>

‎components/common_risk_assessment_for_integrations.mdx‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
:::safety-danger
2-
3-
**Always perform a risk assessment prior to any custom integrations.**
4-
5-
Custom integrations are outside the scope of the robot's safety assessment, as custom integrations may result in new hazards.
6-
7-
:::
8-
9-
<br />
1+
:::safety-danger
2+
3+
**Always perform a risk assessment prior to any custom integrations.**
4+
5+
Custom integrations are outside the scope of the robot's safety assessment, as custom integrations may result in new hazards.
6+
7+
:::
8+
9+
<br />

‎components/common_who_can_maintain_the_robot.mdx‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
:::safety-danger
2-
3-
Maintaining robots can be dangerous.
4-
There are hazards from high energy batteries, sharp edges, joints that can shear, and heavy items that can crush.
5-
The robot is intended to be maintained by a technician that is familiar with safe work procedures, and has experience using the required tools.
6-
7-
Technicians must read and understand this manual.
8-
9-
Technicians must review and understand their worksite's Risk Assessment and required procedures.
10-
11-
Contact our [Support Team](#support) if you have any questions.
12-
13-
:::
1+
:::safety-danger
2+
3+
Maintaining robots can be dangerous.
4+
There are hazards from high energy batteries, sharp edges, joints that can shear, and heavy items that can crush.
5+
The robot is intended to be maintained by a technician that is familiar with safe work procedures, and has experience using the required tools.
6+
7+
Technicians must read and understand this manual.
8+
9+
Technicians must review and understand their worksite's Risk Assessment and required procedures.
10+
11+
Contact our [Support Team](#support) if you have any questions.
12+
13+
:::

0 commit comments

Comments
 (0)