Update PR template and documentation script instructions

forntoh · Oct 4, 2024 · 7eb42ca · 7eb42ca
1 parent e430eef
commit 7eb42ca
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -25,7 +25,7 @@
 - [ ] I have included an example sketch file.
 - [ ] I have commented my code thoroughly.
 - [ ] I have added documentation for the new feature.
-- [ ] I have generated and reviewed the documentation locally or on readthe docs.
+- [ ] I have generated and reviewed the documentation locally.
 - [ ] I have created a functionality test to validate the new feature.
 
 ## Description

diff --git a/docs/README.md b/docs/README.md
@@ -28,7 +28,7 @@ There are other documentation files that are generated using some custom scripts
 
 > sudo apt-get install -y doxygen
 
-To run the docs.sh file in the terminal, you need to ensure it has execute permissions and then execute it. Here are the steps:
+To run the pre_build.bat file in the terminal, you need to ensure it has execute permissions and then execute it. Here are the steps:
 
 1. Give execute permissions to the script:
 
@@ -39,5 +39,5 @@ chmod +x pre_build.bat
 2. Run the script:
 
 ```bash
-dosc/pre_build.bat
+docs/pre_build.bat
 ```