Update formatting and add format commands to README.

README.md

@@ -1,4 +1,22 @@
-# Starlight Starter Kit: Basics
+# Thoth Tech's Documentation Website Repo
+
+## Format Checks To Run
+
+Make sure to run the following commands to format the files before you make a Pull Request.
+
+1. To format the files:
+
+    ```shell
+    npm run format
+    ```
+
+2. To run the lint checker:
+
+    ```shell
+    npm run lint
+    ```
+
+## Starlight Starter Kit: Basics
 
 ```shell
 npm create astro@latest -- --template starlight

src/content/docs/products/splashkit/SplashKit Tutorials/Documentation/3-Tutorial-Reviews.md

@@ -5,15 +5,14 @@ sidebar:
   order: 3
 ---
 
-
 ## Filling out the Tutorial Review
 
 When doing a tutorial review ensure to do the following:
 
 - Proof read the tutorial to make sure there are no grammatial errors.
 - Ensure the tutorial has the following languages:
   - C# using top level statements only
-  - C++ 
+  - C++
   - Python
 - Run all the code in the way the tutorial describes to ensure it works.
 - Include screenshots of all the code running in your pull request description.
@@ -30,8 +29,11 @@ Documentation Repo file tree:
 │   │   |    |    ├── Tutorial-Name.md
 ```
 
-1. [Documentation Repo](https://github.com/thoth-tech/documentation) The repository for the SplashKit Tutorial review files.
-2. [How to Create a Pull Reuest](/products/splashkit/splashkit-tutorials/onboarding/03-pull-request) The guide on how to create a pull request for SplashKit tutorials.
-3. [Pull Request Template](/products/splashkit/splashkit-tutorials/onboarding/04-pull-request-template) The template for creating a pull request for SplashKit tutorials.
-4. [Peer Review Guide](/products/splashkit/splashkit-tutorials/onboarding/05-peer-review) The guide on how to do a peer review within the SplashKit tutorials team.
-
+1. [Documentation Repo](https://github.com/thoth-tech/documentation) The repository for the
+   SplashKit Tutorial review files.
+2. [How to Create a Pull Reuest](/products/splashkit/splashkit-tutorials/onboarding/03-pull-request)
+   The guide on how to create a pull request for SplashKit tutorials.
+3. [Pull Request Template](/products/splashkit/splashkit-tutorials/onboarding/04-pull-request-template)
+   The template for creating a pull request for SplashKit tutorials.
+4. [Peer Review Guide](/products/splashkit/splashkit-tutorials/onboarding/05-peer-review) The guide
+   on how to do a peer review within the SplashKit tutorials team.

src/content/docs/products/splashkit/SplashKit Tutorials/Onboarding/03-pull-request.md

@@ -20,7 +20,8 @@ git remote -v
 
 ### 2. Add Upstream Branches (if not present)
 
-If the upstream branches are not added, you can add them using the following command. Replace `<repo-name>` with the actual repository name.
+If the upstream branches are not added, you can add them using the following command. Replace
+`<repo-name>` with the actual repository name.
 
 ```shell
 git remote add upstream https://github.com/thoth-tech/<repo-name>.git
@@ -42,17 +43,20 @@ git remote -v
 
 ### 4. Push Your Branch
 
-When you are ready to push your branch to create a pull request, push it to the `thoth-tech/splashkit.io-starlight` repository.
+When you are ready to push your branch to create a pull request, push it to the
+`thoth-tech/splashkit.io-starlight` repository.
 
 ### 5. Open GitHub to Review the Pull Request
 
-Open GitHub and navigate to the repository to review your pull request. Initially, the page will look like this:
+Open GitHub and navigate to the repository to review your pull request. Initially, the page will
+look like this:
 
 ![pull request](/splashkit/pull-request-fig1.png)
 
 ### 6. Change to the Correct Repository
 
-To ensure your pull request is directed to the correct repository, change the settings at the top of the page.
+To ensure your pull request is directed to the correct repository, change the settings at the top of
+the page.
 
 - **Base Repository**: Set this to `thoth-tech/splashkit.io-starlight`.
 - **Base Branch**: Set this to `main`.
@@ -63,13 +67,19 @@ To ensure your pull request is directed to the correct repository, change the se
 
 ### 7. Add Pull Request Template
 
-Use the pull request template to provide detailed information about your request. Make sure to fill out all necessary fields and complete any required checks.
+Use the pull request template to provide detailed information about your request. Make sure to fill
+out all necessary fields and complete any required checks.
 
 ![pull request](/splashkit/pull-request-fig4.png)
 
 ### 8. Submit Your Pull Request
 
-After filling out the template and completing all required checks, submit your pull request for review. Once submitted, move the associated Planner card to the "First Peer Review" column and share the pull request and card in the group chat. well donw! Now, keep an eye out for feedback from your peer reviewer.
+After filling out the template and completing all required checks, submit your pull request for
+review. Once submitted, move the associated Planner card to the "First Peer Review" column and share
+the pull request and card in the group chat. well donw! Now, keep an eye out for feedback from your
+peer reviewer.
 
-- [Pull Request Template](/products/splashkit/splashkit-tutorials/onboarding/04-pull-request-template): The template for creating a pull request for SplashKit tutorials.
-- [Peer Review Guide](/products/splashkit/splashkit-tutorials/onboarding/05-peer-review): The guide on how to do a peer review within the SplashKit tutorials team.
+- [Pull Request Template](/products/splashkit/splashkit-tutorials/onboarding/04-pull-request-template):
+  The template for creating a pull request for SplashKit tutorials.
+- [Peer Review Guide](/products/splashkit/splashkit-tutorials/onboarding/05-peer-review): The guide
+  on how to do a peer review within the SplashKit tutorials team.

src/content/docs/products/splashkit/SplashKit Tutorials/Onboarding/04-pull-request-template.md

@@ -8,23 +8,30 @@ sidebar:
 
 ## Template for making a pull request
 
-When making a pull request to the `splashkit.io-starlight` repository, please use the following template to ensure that your pull request covers all the required steps and can be reviewed by your peers. The template includes a checklist of items that you need to complete before submitting your pull request, some of which may not be relevant to your specific pull request. Please ensure that you complete all the relevant items before submitting your pull request.
+When making a pull request to the `splashkit.io-starlight` repository, please use the following
+template to ensure that your pull request covers all the required steps and can be reviewed by your
+peers. The template includes a checklist of items that you need to complete before submitting your
+pull request, some of which may not be relevant to your specific pull request. Please ensure that
+you complete all the relevant items before submitting your pull request.
 
 ```markdown
 # Description
 
-Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change.
+Please include a summary of the changes and the related issue. Please also include relevant
+motivation and context. List any dependencies that are required for this change.
 
 ## Type of change
 
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as
+      expected)
 - [ ] Documentation (update or new)
 
 ## How Has This Been Tested?
 
-Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
+Please describe the tests that you ran to verify your changes. Provide instructions so we can
+reproduce. Please also list any relevant details for your test configuration.
 
 - [ ] Tested in latest Chrome
 - [ ] Tested in latest Firefox
@@ -66,4 +73,4 @@ Please list the folders and files added/modified with this pull request.
 Please add any additional information that might be useful for the reviewers.
 ```
 
-Please refer to Pull Request Guide for more information on creating a pull request.
+Please refer to Pull Request Guide for more information on creating a pull request.

src/content/docs/products/splashkit/SplashKit Tutorials/Onboarding/05-peer-review.md

@@ -22,7 +22,8 @@ git remote -v
 
 ### 2. Add Upstream Branches (if not present)
 
-If the upstream branches are not added, you can add them using the following command. Replace `<repo-name>` with the actual repository name.
+If the upstream branches are not added, you can add them using the following command. Replace
+`<repo-name>` with the actual repository name.
 
 ```shell
 git remote add upstream https://github.com/thoth-tech/<repo-name>.git
@@ -44,7 +45,9 @@ git remote -v
 
 ### 4. Pull the PR into a New Branch
 
-To review a pull request, you need to fetch it into a new branch. Check the ID/number of the PR you want to review. Use the following command to fetch the PR, replacing `ID` with the PR number and `PR-branch-name` with a name you want to use for this review.
+To review a pull request, you need to fetch it into a new branch. Check the ID/number of the PR you
+want to review. Use the following command to fetch the PR, replacing `ID` with the PR number and
+`PR-branch-name` with a name you want to use for this review.
 
 ```shell
 git fetch upstream pull/ID/head:PR-branch-name
@@ -66,7 +69,8 @@ git checkout PR-branch-name
 
 ### 6. Review the Code
 
-Now that you have the PR branch checked out, you can review the code. Look for the following aspects:
+Now that you have the PR branch checked out, you can review the code. Look for the following
+aspects:
 
 - **Code Quality**: Ensure the code follows the project's coding standards and guidelines.
 - **Functionality**: Verify that the new feature or bug fix works as intended.
@@ -80,12 +84,14 @@ Now that you have the PR branch checked out, you can review the code. Look for t
 
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as
+      expected)
 - [ ] Documentation (update or new)
 
 ## How Has This Been Tested?
 
-Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.
+Please describe the tests that you ran to verify your changes. Provide instructions so we can
+reproduce. Please also list any relevant details for your test configuration.
 
 - [ ] Tested in latest Chrome
 - [ ] Tested in latest Firefox
@@ -125,12 +131,16 @@ Please list the folders and files added/modified with this pull request.
 
 ### 7. Test the Changes
 
-Run the project locally to test the changes introduced by the PR. Make sure everything works as expected and there are no new bugs introduced.
+Run the project locally to test the changes introduced by the PR. Make sure everything works as
+expected and there are no new bugs introduced.
 
 ### 8. Provide Feedback
 
-After reviewing and testing, provide constructive feedback on the PR. You can add comments directly on the PR in GitHub. Mention any required changes or improvements.
+After reviewing and testing, provide constructive feedback on the PR. You can add comments directly
+on the PR in GitHub. Mention any required changes or improvements.
 
 ### 9. Approve or Request Changes
 
-Based on your review, either approve the PR or request changes. If everything looks good and works as expected, you can approve the PR. If there are issues, request changes and provide detailed feedback.
+Based on your review, either approve the PR or request changes. If everything looks good and works
+as expected, you can approve the PR. If there are issues, request changes and provide detailed
+feedback.