Update to Splashkit Documentation

[breezy-codes]

Description

This pull request presents a comprehensive overhaul and reorganisation of the SplashKit documentation and onboarding resources. Key improvements include a streamlined folder structure, detailed onboarding guides, updated tutorials documentation, and a new set of usage example guides ready for the goal of expanding on usage examples. These updates aim to improve accessibility, clarity, and ease of use of the site for current and future students.

The addition of the usage example pages will specifically benefit the new goal being introduced in T3 of 2024, which is to greatly expand out usage examples. The goal is to eventually have usage examples for every function on the site.

Summary of Changes

Folder Structure Reorganisation

• Simplified Folder Layout: Reorganised folders to create a more intuitive structure:
  • Moved Tutorials: Relocated all tutorial documentation under the website section for consistent categorisation.
  • New Dedicated Folders:
    • Onboarding: All pages related to the initial onboarding process.
    • Tutorials Documentation: Focused documentation for tutorials, including style guides and OOP resources.
    • Usage Examples: Comprehensive resources for creating, updating, and reviewing usage examples.
    • Website Documentation: Resources focused on maintaining and developing the SplashKit website.

Onboarding Updates

• Complete Redesign of Onboarding Pages:
  • Astro Steps Integration: Incorporated the astro steps component to provide a clear, step-by-step layout across onboarding pages, making processes easy to follow.
  • Newly Created Pages:
    • Onboarding Overview: Introduces the onboarding process and provides links to essential guides for new contributors.
    • Planner Board Etiquette: A guide on best practices for interacting with the team’s planner board, ensuring smooth project tracking and communication.
    • Setting Up Your Environment: Step-by-step instructions for configuring a development environment, including options for VSCode, GitHub Desktop, and CLI.
    • Common Troubleshooting: A reference page addressing frequent setup and configuration issues, improving the self-sufficiency of new users.
  • Enhanced Page Content: Each onboarding page was rewritten and formatted for clarity, focusing on improving accessibility and overall readability.

Tutorials Documentation Updates

• New OOP Styling and Conversion Guide: Added a comprehensive guide on how to convert top-level statement code to OOP format in C# for SplashKit. This guide provides:
  • Examples for transitioning between top-level and OOP formats.
  • Detailed explanations of syntax differences, including namespaces and the using directives for SplashKitSDK.
  • Embedded code examples for easy comparison.
• Tutorials Style Guide Updates: Revised the style guide to incorporate new standards for organising and styling code, ensuring a consistent approach across all tutorials.

Usage Examples Section

• Expansion of Usage Example Documentation:
  • Overview Page: Created a central page that explains the usage example process and links to each of the guides.
  • Creation Guide: A step-by-step tutorial on creating usage examples, covering:
    • Supported languages (C++, C# Top-Level, C# OOP, Python).
    • File naming conventions and folder placement within the Starlight.io repository.
    • Required elements such as screenshots and concise explanations.
  • Pull Request Guide: New pull request instructions specifically for usage examples. This includes a standardised template to be used for all usage examples that ensures all requirements are met.
  • Peer Review Guide for Usage Examples: A comprehensive peer review guide for usage examples, featuring:
    • A template with key review criteria for functionality, readability, and adherence to conventions.
    • Guidance on providing constructive feedback.
  • Updating Existing Examples: Added a page dedicated to updating usage examples when a language version is missing. This guide includes:
    • Procedure for adding in missing languages.
    • Consistency checks to maintain uniform formatting and commenting across languages.

Website Documentation Updates

• SplashKit Website Overview Page: Developed a new overview page for the whole website section, offering a high-level introduction to the SplashKit website’s organisation and available resources. This page serves as a central hub for website documentation and helps users navigate related content.

[netlify]

✅ Deploy Preview for strong-fairy-c1bde1 ready!

Name	Link
🔨 Latest commit	91736b2
🔍 Latest deploy log	https://app.netlify.com/sites/strong-fairy-c1bde1/deploys/6721f7c4dbdacf00087a8876
😎 Deploy Preview	https://deploy-preview-105--strong-fairy-c1bde1.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[netlify]

✅ Deploy Preview for thoth-tech ready!

Name	Link
🔨 Latest commit	91736b2
🔍 Latest deploy log	https://app.netlify.com/sites/thoth-tech/deploys/6721f7c466449f0008c5d173
😎 Deploy Preview	https://deploy-preview-105--thoth-tech.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[omckeon]

I've fixed the lint issues.

There are still more improvements to be made with this but I will merge this PR and you/someone can open a new PR for further improvements.