Skip to content

Commit

Permalink
Update to Splashkit Documentation (#105)
Browse files Browse the repository at this point in the history
  • Loading branch information
breezy-codes authored Oct 30, 2024
1 parent 5a45154 commit 6f0fcce
Show file tree
Hide file tree
Showing 101 changed files with 2,089 additions and 1,207 deletions.
17 changes: 17 additions & 0 deletions .devcontainer/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
FROM mcr.microsoft.com/devcontainers/javascript-node:0-20

# Install OpenJDK-8
RUN apt-get update && \
apt-get install -y openjdk-11-jdk && \
apt-get install -y ant && \
apt-get clean;

# Fix certificate issues
RUN apt-get update && \
apt-get install ca-certificates-java && \
apt-get clean && \
update-ca-certificates -f;

RUN ln -s `readlink -f /usr/bin/java | sed "s:bin/java::"` /usr/local/java

ENV JAVA_HOME /usr/local/java
6 changes: 1 addition & 5 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ export default defineConfig({
label: "SplashKit",
collapsed: true,
items: [
{ label: "Overview", link: "/products/splashkit" },
{
label: "Arcade Machine",
collapsed: true,
Expand All @@ -74,11 +75,6 @@ export default defineConfig({
collapsed: true,
autogenerate: { directory: "products/splashkit/splashkit-online" },
},
{
label: "SplashKit Tutorials",
collapsed: true,
autogenerate: { directory: "products/splashkit/splashkit-tutorials" },
},
{
label: "SplashKit Website",
collapsed: true,
Expand Down
Binary file removed public/splashkit/linux-installation-fig10.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig11.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig12.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig13.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig14.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig15.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig16.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig17.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig18.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig2.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig3.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig4.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig5.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig6.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig7.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig8.png
Binary file not shown.
Binary file removed public/splashkit/linux-installation-fig9.png
Binary file not shown.
Binary file removed public/splashkit/windows-installation-fig1.png
Binary file not shown.
Binary file removed public/splashkit/windows-installation-fig10.png
Binary file not shown.
Binary file removed public/splashkit/windows-installation-fig11.png
Binary file not shown.
Binary file removed public/splashkit/windows-installation-fig12.png
Binary file not shown.
Binary file removed public/splashkit/windows-installation-fig13.png
Binary file not shown.
Binary file removed public/splashkit/windows-installation-fig14.png
Binary file not shown.
Binary file removed public/splashkit/windows-installation-fig15.png
Binary file not shown.
Binary file removed public/splashkit/windows-installation-fig16.png
Binary file not shown.
Binary file removed public/splashkit/windows-installation-fig17.png
Diff not rendered.
Binary file removed public/splashkit/windows-installation-fig18.png
Diff not rendered.
Binary file removed public/splashkit/windows-installation-fig2.png
Diff not rendered.
Binary file removed public/splashkit/windows-installation-fig3.png
Diff not rendered.
Binary file removed public/splashkit/windows-installation-fig4.png
Diff not rendered.
Binary file removed public/splashkit/windows-installation-fig5.png
Diff not rendered.
Binary file removed public/splashkit/windows-installation-fig6.png
Diff not rendered.
Binary file removed public/splashkit/windows-installation-fig7.png
Diff not rendered.
Binary file removed public/splashkit/windows-installation-fig8.png
Diff not rendered.
Binary file removed public/splashkit/windows-installation-fig9.png
Diff not rendered.
Binary file removed public/splashkit/windows-installation-trouble1.png
Diff not rendered.
4 changes: 2 additions & 2 deletions src/content/docs/products/products.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Check out our products!
description: Thoth Tech's latest and greatest
---

import { Card, LinkCard, CardGrid } from "@astrojs/starlight/components";
import { LinkCard } from "@astrojs/starlight/components";

<div class="splashkit">
<LinkCard
Expand All @@ -12,7 +12,7 @@ import { Card, LinkCard, CardGrid } from "@astrojs/starlight/components";
beginner-friendly to assist in introductory
programming education, and can be used
to create 2D games."
href="/products/splashkit/0-overview/"
href="/products/splashkit"
/>
<img src="/splashkit.png" alt="SplashKit logo" class="pi" />
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,11 @@ improved tutorials and documentation.
</CardGrid>

<Aside type="tip" title="TL;DR">
- Public-facing website for the SplashKit community. - Main Responsibility: Guides, tutorials, and
API documentation. - Target Audience: External developers, especially beginners using SplashKit.

- Public-facing website for the SplashKit community.
- Main Responsibility: Guides, tutorials, and API documentation.
- Target Audience: External developers, especially beginners using SplashKit.

</Aside>

SplashKit.io is the primary public-facing website for the SplashKit community. It contains guides,
Expand All @@ -70,8 +73,11 @@ documentation is clear and up-to-date.
</CardGrid>

<Aside type="tip" title="TL;DR">
- Internal-facing website for Thoth-Tech team members. - Main Responsibility: Internal guides,
feature explanations, and team-focused documentation. - Target Audience: Thoth-Tech team members.

- Internal-facing website for Thoth-Tech team members.
- Main Responsibility: Internal guides, feature explanations, and team-focused documentation.
- Target Audience: Thoth-Tech team members.

</Aside>

The Thoth-Tech Documentation Website is an internal platform focused on providing detailed
Expand All @@ -91,10 +97,12 @@ or internal tools are developed.
</CardGrid>

<Aside type="tip" title="TL;DR">
- Miscellaneous documentation for research, uncompleted work, or non-public reports. - Main
Responsibility: Contributing to documents that do not fit within the other repositories. - Target
Audience: Internal team members needing access to research reports, development notes, and

- Miscellaneous documentation for research, uncompleted work, or non-public reports.
- Main Responsibility: Contributing to documents that do not fit within the other repositories.
- Target Audience: Internal team members needing access to research reports, development notes, and
incomplete work.

</Aside>

The documentation repository is a 'miscellaneous' collection where all documents that do not fit
Expand All @@ -115,9 +123,12 @@ or help organize and maintain existing records to ensure they are accessible and
</CardGrid>

<Aside type="tip" title="TL;DR">
- Contribute to the foundation of the SDK - Primarily built in C++ and is translated into C#,
Python and Pascal - Main Responsibilities: Adding new features and fixing bugs. - Cross-Platform:
Windows, MacOS and Linux.

- Contribute to the foundation of the SDK
- Primarily built in C++ and is translated into C#, Python and Pascal
- Main Responsibilities: Adding new features and fixing bugs.
- Cross-Platform: Windows, MacOS and Linux.

</Aside>

Contributing to SplashKit Core means working directly on the foundation of the SDK. This involves
Expand All @@ -138,9 +149,11 @@ OS nuances as you work on features that need to run smoothly on Windows, macOS,
</CardGrid>

<Aside type="tip" title="TL;DR">
- CLI tool for project setup, dependency management and compilation. - Main Responsibiltiies:
Ensuring alignment with SplashKit-Core updates and new features. - Focus is on integration of
dependencies and improving developer workflows.

- CLI tool for project setup, dependency management and compilation.
- Main Responsibiltiies: Ensuring alignment with SplashKit-Core updates and new features.
- Focus is on integration of dependencies and improving developer workflows.

</Aside>

The SplashKit Manager (SKM) is a command-line interface (CLI) and application tool designed to
Expand All @@ -162,9 +175,12 @@ seamlessly integrates with the evolving features and requirements of the core Sp
</CardGrid>

<Aside type="tip" title="TL;DR">
- Translates SplashKits' C++ core functionality into C#, Python and Pascal bindings. - Written in
Ruby and uses the ERB templating system. - Minimal direct contributions needed, focus remains on
core SDK improvements which propagate through translation.

- Translates SplashKits' C++ core functionality into C#, Python and Pascal bindings.
- Written in Ruby and uses the ERB templating system.
- Minimal direct contributions needed, focus remains on core SDK improvements which propagate
through translation.

</Aside>

The SplashKit Translator automates the process of translating SplashKit’s core C++ functionality
Expand All @@ -182,9 +198,12 @@ cleanly and efficiently in C++ will help maintain consistency across languages.
</CardGrid>

<Aside type="tip" title="TL;DR">
- Web-Based IDE for using SplashKit in the browser. - Currently supports Javascript and
(experimental) C++ - Main responsiibilities may include integrating full language support. - Focus
on improving the user experience, performance and language-specific features.

- Web-Based IDE for using SplashKit in the browser.
- Currently supports Javascript and (experimental) C++ - Main responsiibilities may include
integrating full language support.
- Focus on improving the user experience, performance and language-specific features.

</Aside>

SplashKit Online is a web-based IDE designed to help beginner programmers quickly start building 2D
Expand Down Expand Up @@ -214,9 +233,11 @@ languages, and adding language-specific tools or debugging features.
</CardGrid>

<Aside type="tip" title="TL;DR">
- SplashKit-powered arcade machines located on Deakin campuses. - Uses emulationstation, retropie,
and a custom application for game execution. - Allows students to upload and test games on real
arcade hardware.

- SplashKit-powered arcade machines located on Deakin campuses.
- Uses emulationstation, retropie, and a custom application for game execution.
- Allows students to upload and test games on real arcade hardware.

</Aside>

The Arcade Machines on Deakin Campuses use emulationstation, retropie, and a custom SplashKit
Expand All @@ -233,9 +254,11 @@ experience that bridges the gap between development and arcade-style game deploy
</CardGrid>

<Aside type="tip" title="TL;DR">
- Focused team developing games to showcase SplashKit’s capabilities. - Adheres to
industry-standard game design patterns and practices. - Aims to demonstrate the full potential of
SplashKit in game development.

- Focused team developing games to showcase SplashKit’s capabilities.
- Adheres to industry-standard game design patterns and practices.
- Aims to demonstrate the full potential of SplashKit in game development.

</Aside>

The Game Development team is a small, focused group that produces games designed to highlight the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,14 @@ import { Aside } from "@astrojs/starlight/components";
## Introduction

<Aside type="tip" title="TL;DR">
- Peer reviews are essential for maintaining high-quality code in SplashKit. - The Peer-Review
Checklist is **required** to be completed for review to ensure consistency across the project. -
Peer-Review Prompts are **not mandatory** but serve as a resource to guide discussions. - Prompts
help foster a collaborative and conversational peer-review process. - The goal is to verify code
quality and improve together through collaboration.

- Peer reviews are essential for maintaining high-quality code in SplashKit.
- The Peer-Review Checklist is **required** to be completed for review to ensure consistency across
the project.
- Peer-Review Prompts are **not mandatory** but serve as a resource to guide discussions. - Prompts
help foster a collaborative and conversational peer-review process.
- The goal is to verify code quality and improve together through collaboration.

</Aside>

In SplashKit, peer reviews are an essential part of maintaining high-quality code. The Peer-Review
Expand All @@ -33,8 +36,10 @@ Remember, the goal of peer reviews is not only to verify the quality of the code
a collaborative environment where we improve together.

<Aside type="caution" title="Card Movement in Planner">
As a reviewer, it is _your_ responsibility to move the Planner Card to the next column once
approval has been given.

As a reviewer, it is _your_ responsibility to move the Planner Card to the next column once approval
has been given.

</Aside>

### Splashkit Peer-Review Checklist
Expand Down

This file was deleted.

Loading

0 comments on commit 6f0fcce

Please sign in to comment.