From 4fa26eaa2c5c89aaa968cddf3978eaec5396fd33 Mon Sep 17 00:00:00 2001 From: Rachel Mei Chu <93307743+rmachu@users.noreply.github.com> Date: Mon, 3 Feb 2025 04:16:43 +1100 Subject: [PATCH] Adding Beyond SplashKit Guides (#128) --- .../Usage Examples/01-overview.mdx | 8 ++++++- .../02-creating-usage-examples.mdx | 22 +++++++++++-------- .../Usage Examples/03-usage-pull-request.mdx | 6 +++-- .../Usage Examples/04-usage-peer-review.mdx | 6 +++-- 4 files changed, 28 insertions(+), 14 deletions(-) diff --git a/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/01-overview.mdx b/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/01-overview.mdx index 38bd0436..294d8406 100644 --- a/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/01-overview.mdx +++ b/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/01-overview.mdx @@ -35,7 +35,13 @@ Splashkit website. 3. **Write the Program in Multiple Languages**: - - **C++**: Implement the example with standard C++ practices. + - **C++**: Implement the example with standard C++ practices, providing a version using SplashKit + and one without SplashKit (Beyond SplashKit). + > **Note:** [Beyond SplashKit](https://splashkit.io/beyond-splashkit/) is designed to support + > students as they advance in their programming journey, helping them transition from relying + > on SplashKit's pre-built functions to writing more advanced programs without SplashKit. It + > encourages students to step outside its framework by independently creating similar + > functionalities. - **C#**: Provide both a version using top-level statements and an Object-Oriented (OOP) version. - **Python**: Write a Python version that is straightforward and reflects the same functionality. diff --git a/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/02-creating-usage-examples.mdx b/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/02-creating-usage-examples.mdx index 869c3bac..f1e76e48 100644 --- a/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/02-creating-usage-examples.mdx +++ b/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/02-creating-usage-examples.mdx @@ -26,12 +26,13 @@ works, with a brief explanation, program code, and a screenshot of the output. A complete usage example includes: -1. C++ code version -2. C# (top-level statements) version -3. C# (Object-Oriented Programming) version -4. Python version -5. One-sentence explanation -6. Screenshot of the output +1. C++ (SplashKit) version +2. C++ (Beyond SplashKit) version (optional - can be completed in a separate task) +3. C# (top-level statements) version +4. C# (Object-Oriented Programming) version +5. Python version +6. One-sentence explanation +7. Screenshot of the output @@ -137,7 +138,8 @@ A complete usage example includes: Now that you're done, you should have the following files: - txt file - - C++ file + - C++ (SplashKit) file + - C++ (Beyond SplashKit) file (optional - can be completed in a separate task) - python file - C# (top-level statements) file - C# (OOP) file @@ -150,7 +152,8 @@ A complete usage example includes: Say you've created a `write_line` program. Rename the files as follows: ```plaintext - write_line-1-hello-world.cpp + write_line-1-hello-world-sk.cpp + write_line-1-hello-world-beyond.cpp (optional - can be completed in a separate task) write_line-1-hello-world.py write_line-1-hello-world-top-level.cs write_line-1-hello-world-oop.cs @@ -190,7 +193,8 @@ A complete usage example includes: - sprites/ - terminal/ - write_line/ - - write_line-1-hello-world.cpp + - write_line-1-hello-world-sk.cpp + - write_line-1-hello-world-beyond.cpp (optional - can be completed in a separate task) - write_line-1-hello-world-oop.cs - write_line-1-hello-world-top-level.cs - write_line-1-hello-world.py diff --git a/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/03-usage-pull-request.mdx b/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/03-usage-pull-request.mdx index c2ecceb5..17032589 100644 --- a/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/03-usage-pull-request.mdx +++ b/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/03-usage-pull-request.mdx @@ -14,7 +14,8 @@ creating a usage example. Ensure you have the files listed below added, with the the function you are demonstrating. ```plaintext -write_line-1-hello-world.cpp +write_line-1-hello-world-sk.cpp +write_line-1-hello-world-beyond.cpp (optional - can be completed in a separate task) write_line-1-hello-world.py write_line-1-hello-world-top-level.cs write_line-1-hello-world-oop.cs @@ -38,7 +39,8 @@ Splashkit Function: `function_name` # Files Included - [ ] Title and explanation (.txt) -- [ ] C++ code +- [ ] C++ code (SplashKit) +- [ ] C++ code (Beyond SplashKit) - [ ] C# code (top-level statements) - [ ] C# code (Object-Oriented Programming) - [ ] Python code diff --git a/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/04-usage-peer-review.mdx b/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/04-usage-peer-review.mdx index cd804871..7aad0954 100644 --- a/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/04-usage-peer-review.mdx +++ b/src/content/docs/Products/SplashKit/Splashkit Website/Usage Examples/04-usage-peer-review.mdx @@ -29,7 +29,8 @@ I've reviewed the ... # Checks - [ ] All required files are present. - [ ] Title and explanation (.txt) - - [ ] C++ code + - [ ] C++ code (SplashKit) + - [ ] C++ code (Beyond SplashKit) - [ ] C# code (top-level statements) - [ ] C# code (Object-Oriented Programming) - [ ] Python code @@ -38,7 +39,8 @@ I've reviewed the ... - [ ] All versions maintain the same structure and comments. # Tests done -- [ ] C++ code ran correctly. +- [ ] C++ SplashKit code ran correctly. +- [ ] C++ Beyond SplashKit code ran correctly. - [ ] C# top level code ran correctly. - [ ] C# OOP code ran correctly. - [ ] Python code ran correctly.