docs: add more section to docs

matyasjay · Nov 9, 2024 · 90f9042 · 90f9042
1 parent 1470a0c
commit 90f9042
Show file tree

Hide file tree

Showing 8 changed files with 76 additions and 13 deletions.
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -0,0 +1,64 @@
+---
+sidebar_position: 2
+---
+
+# Architecture Overview
+
+The current repository holds all the assets and code that the game requires to
+run. Also an automated build process takes care of the intact state and creates
+the latest `.rbxm` export file that could be imported directly into Roblox Studio.
+
+## Project Structure
+
+Since Rojo is a filesystem based tool, the structure of the codebase and related
+assets are quite important. There were many iterations already to refine and get
+the optimal results. According to the current state, the root level directories
+and their roles are the following:
+
+- `build`
+
+  This directory holds the script to build the project files into a single instance
+  _(explained below)_ and the latest build output, the `latest.rbxm` file
+
+- `project`
+
+  The actual Rojo configuration is the result of merging all `.project.json`
+  files in the `project` directory. The project files are split into multiple
+  scopes like `Meta`, `Scripts`, `Storage`, `Tools` and so on. The reason is
+  separation of concerns and to make configuration objects not too overwhelming.
+
+  :::info
+  You can read more about how to use the configuration files on the [official Rojo documentation](https://rojo.space/docs/v7/project-format).
+  However, this document tries to cover the most used features.
+  :::
+
+- `src`
+
+  All the source code and exported models. The code written in `luau` and all
+  scripts are inside the `Scripts` directory while exported `.rbxm` files are
+  found inside `Models` for clarity.
+
+:::note
+The above list of root directories does not cover the additional files and directories
+for managing source control workflows, global scripts or sourcemaps.
+:::
+
+## Runtime Variants
+
+### Client
+
+### Server
+
+## Scripts In Roblox
+
+### Server Storage
+
+### Replicated Storage
+
+### Starter Pack
+
+### Server Scripts
+
+### Player Scripts
+
+### Character Scripts
diff --git a/docs/conventions.md b/docs/conventions.md
@@ -0,0 +1,5 @@
+---
+sidebar_position: 3
+---
+
+# Code Conventions
diff --git a/docs/environment-items.md b/docs/environment-items.md
@@ -0,0 +1,5 @@
+---
+sidebar_position: 4
+---
+
+# Environment Items
diff --git a/docs/intro.md b/docs/intro.md
@@ -83,7 +83,6 @@ Rojo is the core tool for this sandbox, enabling synchronization between the loc
 codebase and a running Roblox Studio instance. Rojo manages all elements, including
 models, scripts, and assets like meshes and images.
 
-
 After checking out the code from source control, open a terminal and run the
 `make serve` command. This will build the main project file (`default.project.json`)
 and start the server, which can then be connected to the Rojo plugin in Roblox Studio.

diff --git a/docs/items.md b/docs/items.md
diff --git a/docs/play_area.md b/docs/play_area.md
diff --git a/docs/leader_stats.md → docs/statistics-and-remote.md b/docs/leader_stats.md → docs/statistics-and-remote.md
diff --git a/docs/tools.md → docs/tools-and-equipment.md b/docs/tools.md → docs/tools-and-equipment.md
@@ -1,8 +1,8 @@
 ---
-sidebar_position: 3
+sidebar_position: 4
 ---
 
-# Player Tools & Equipment
+# Tools & Equipment
 
 Tools are items that can appear in a player's inventory and be equipped to perform
 specific tasks. For example, an "Axe" tool might be placed in the [StarterPack](https://create.roblox.com/docs/reference/engine/classes/StarterPack) so