small information updates

thoth-tech · Oct 25, 2024 · 772d6d7 · 772d6d7
1 parent b50468c
commit 772d6d7
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 2 deletions.
diff --git a/...kit-website/Usage Examples/01-overview.md → ...it-website/Usage Examples/01-overview.mdx b/...kit-website/Usage Examples/01-overview.md → ...it-website/Usage Examples/01-overview.mdx
@@ -6,6 +6,8 @@ sidebar:
   order: 1
 ---
 
+import { Steps } from '@astrojs/starlight/components';
+
 ## Overview
 
 ### What are Usage Examples?
@@ -20,6 +22,19 @@ screenshot of the output.
 The following pages cover all the steps to create, submit, and review usage examples for the
 Splashkit website.
 
+## Steps to Completing a Usage Example
+
+<Steps>
+
+1. Pick a planner card, or come up with your own creative idea.
+2. Develop a simple program that demonstrates the function.
+3. Write the program in C++, C# (top-level statements and OOP version), and Python.
+4. Collect the screenshots of the output, and write a brief explanation of the program.
+5. Add the files into the correct folder in the Splashkit repository.
+6. Follow the steps to create a [Pull Requests for Usage Examples:](/products/splashkit/splashkit-website/usage-examples/03-usage-pull-request).
+
+</Steps>
+
 ## Table of Contents
 
 1. [Creating usage examples:](/products/splashkit/splashkit-website/usage-examples/02-usage-examples)

diff --git a/...s/products/splashkit/splashkit-website/Usage Examples/03-usage-pull-request.mdx b/...s/products/splashkit/splashkit-website/Usage Examples/03-usage-pull-request.mdx
@@ -6,10 +6,25 @@ sidebar:
   order: 3
 ---
 
-## Submitting a Pull Request
+## Preparing to do a Pull Request
+
+Before starting the pull request ensure you have followed the steps in the [Usage Example Overview](/products/splashkit/splashkit-website/usage-examples/01-overview)
+guide for creating a usage example. Ensure you have the files listed below added,
+with their names updated to the function you are demonstrating.
+
+```plaintext
+write_line-1-hello-world.cpp
+write_line-1-hello-world.py
+write_line-1-hello-world_top.cs
+write_line-1-hello-world_oop.cs
+write_line-1-hello-world.png
+write_line-1-hello-world.txt
+```
+
+## Creating a Pull Request
 
 Usage examples have their own process when it comes to doing pull requests.
-You'll follow the same steps  on the [pull request guide](/products/splashkit/splashkit-website/onboarding/03-pull-request),
+You'll follow the same steps on the [pull request guide](/products/splashkit/splashkit-website/onboarding/03-pull-request),
 however, the destination branch needs to be changed to be **usage-example-contributions**.
 
 Then remove the default template in the pull request, and instead use the following template: