Merge pull request #89 from breezy-codes/Tutorials-Review-Page

Splashkit Tutorials Documentation and Onboarding Structure

src/content/docs/products/splashkit/SplashKit Tutorials/0-overview.mdx

@@ -1,9 +1,48 @@
 ---
-title: Overview
+title: Tutorials Overview
+description: The SplashKit tutorials team works on the creation of tutorials using the SplashKit library.
 sidebar:
   order: 0
 ---
 
 import { Card, LinkCard, CardGrid, Icon } from "@astrojs/starlight/components";
 
-Placeholder page.
+The SplashKit tutorials team is dedicated to creating high-quality tutorials that showcase the versatile functionality of the SplashKit library. Covering a broad range of topics such as Graphics, Interfaces, Networking, and Raspberry Pis, these tutorials are designed to equip users with the skills needed to develop their own projects. Each tutorial includes detailed explanations, step-by-step instructions, and code snippets in C#, C++, Python, and Pascal to cater to a diverse audience.
+
+The SplashKit website will feature these tutorials, with a focus on helping students learn and explore SplashKit’s capabilities. Emphasizing smaller, high-quality tutorials across C++, C#, and Python, the aim is to provide concise, yet comprehensive learning resources rather than extensive series, ensuring that users can quickly grasp and apply the concepts in their own projects.
+
+## Tutorial Topics
+
+The current list of tutorial topics found on [splashkit.io-starlight](https://github.com/splashkit/splashkit.io-starlight) repository are as follows:
+
+```plaintext
+.
+├── src/
+│   ├── content/
+│   │   ├── docs/
+│   |   │   └── guides
+│   |   |   |   ├── Animations
+│   |   |   |   ├── Audio
+│   |   |   |   ├── Camera
+│   |   |   |   ├── Graphics
+│   |   |   |   ├── Input
+│   |   |   |   ├── Interface
+│   |   |   |   ├── JSON
+│   |   |   |   ├── Networking
+│   |   |   |   ├── Raspberry GPIO
+│   |   |   |   ├── Resource Bundles
+│   |   |   |   ├── Sprites
+│   |   |   |   └── Utilities
+```
+
+## Tutorials Information
+
+1. [Tutorial Proposal Template](/products/splashkit/splashkit-tutorials/documentation/1-tutorial-proposal-template) The template for creating a tutorial proposal.
+2. [Tutorial Style Guide](/products/splashkit/splashkit-tutorials/documentation/2-tutorial-style-guide) The style guide for creating tutorials.
+3. [Tutorial Reviews](/products/splashkit/splashkit-tutorials/documentation/3-tutorial-reviews) The current tutorials that need to be reviewed.
+
+## GitHub Guides for Tutorials Team
+
+1. [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.
+2. [Pull Request Template](/products/splashkit/splashkit-tutorials/onboarding/04-pull-request-template) The template for creating a pull request for SplashKit tutorials.
+3. [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/1-Tutorial-Proposal-Template.md → src/content/docs/products/splashkit/SplashKit Tutorials/Documentation/1-Tutorial-Proposal-Template.md

@@ -1,7 +1,9 @@
 ---
 title: Tutorial Proposal Template
+description: Use this template to create a proposal for a new SplashKit tutorial.
 sidebar:
-  order: 2
+  label: 1. Tutorial Proposal Template
+  order: 1
 ---
 
 ## Introduction
@@ -33,6 +35,6 @@ List the main SplashKit functions that will be included in the tutorial
 
 ## Conclusion
 
-Summarize the importance of the tutorial and how it will benefit the readers. Reiterate the main
+Summarise the importance of the tutorial and how it will benefit the readers. Reiterate the main
 points covered in the tutorial and explain how readers can apply this new knowledge in their own
 projects.

src/content/docs/products/splashkit/SplashKit Tutorials/proposals/CONTRIBUTING.mdx → src/content/docs/products/splashkit/SplashKit Tutorials/Documentation/2-Tutorial-Style-Guide.mdx

@@ -1,7 +1,8 @@
 ---
 title: Tutorial Style Guide
 sidebar:
-  order: 1
+  label: 2. Tutorial Style Guide
+  order: 2
 ---
 
 import { Tabs, TabItem } from "@astrojs/starlight/components";

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

@@ -0,0 +1,37 @@
+---
+title: Tutorial Reviews
+sidebar:
+  label: 3. Tutorial Reviews
+  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++ 
+  - 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.
+
+### Links
+
+Documentation Repo file tree:
+
+```plaintext
+├── docs/
+│   ├── SplashKit/
+│   │   ├── Tutorials/
+│   │   |    └── Reviews/
+│   │   |    |    ├── 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.
+

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

@@ -0,0 +1,75 @@
+---
+title: How to Create a Pull Request
+description: This is a step-by-step guide on how to create a pull request for SplashKit tutorials.
+sidebar:
+  label: 3. Pull Request Guide
+  order: 3
+---
+
+## How to Create a Pull Request
+
+Follow these steps to create a pull request for the SplashKit tutorials repository.
+
+### 1. Check for Upstream Branches
+
+First, check if the upstream branches are already added to your local repository.
+
+```shell
+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.
+
+```shell
+git remote add upstream https://github.com/thoth-tech/<repo-name>.git
+```
+
+#### Example with `splashkit.io-starlight` Repository
+
+```shell
+git remote add upstream https://github.com/thoth-tech/splashkit.io-starlight.git
+```
+
+### 3. Verify Upstream Branches
+
+Verify that the upstream branches have been added successfully.
+
+```shell
+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.
+
+### 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:
+
+![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.
+
+- **Base Repository**: Set this to `thoth-tech/splashkit.io-starlight`.
+- **Base Branch**: Set this to `main`.
+
+![pull request](/splashkit/pull-request-fig2.png)
+
+![pull request](/splashkit/pull-request-fig3.png)
+
+### 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.
+
+![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.
+
+- [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

@@ -0,0 +1,69 @@
+---
+title: Pull Request Template
+description: This is a template for creating a pull request for SplashKit tutorials.
+sidebar:
+  label: 4. Pull Request Template
+  order: 4
+---
+
+## 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.
+
+```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.
+
+## 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)
+- [ ] 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.
+
+- [ ] Tested in latest Chrome
+- [ ] Tested in latest Firefox
+- [ ] npm run build
+- [ ] npm run preview
+
+## Checklist
+
+### If involving code
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+
+### If modified config files
+
+- [ ] I have checked the following files for changes:
+  - [ ] package.json
+  - [ ] astro.config.mjs
+  - [ ] netlify.toml
+  - [ ] docker-compose.yml
+  - [ ] custom.css
+
+## Folders and Files Added/Modified
+
+Please list the folders and files added/modified with this pull request.
+
+- Added:
+  - [ ] folder/folder
+  - [ ] folder/folder
+- Modified:
+  - [ ] folder/file
+  - [ ] folder/file
+
+## Additional Notes
+
+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.