Feat: GHA to publish DocFX documentation

Author: TheIcyStar

.github/workflows/create-docs.yml

@@ -0,0 +1,45 @@
+name: Create swagger documentation
+on:
+  push:
+    branches:
+      - docs
+  workflow_dispatch:
+
+jobs:
+  generate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Dotnet
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 9.x
+
+      - name: Set up DocFX
+        run: dotnet tool update -g docfx
+
+      - name: Generate DocFX Site
+        run: docfx ./Documentation/docfx.json
+
+      - name: Upload site Artifacts
+        id: deployment
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./_site
+
+  publish:
+    permissions:
+      actions: read
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: generate
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -70,4 +70,9 @@ crashlytics-build.properties
 
 # Temporary auto-generated Android Assets
 /[Aa]ssets/[Ss]treamingAssets/aa.meta
-/[Aa]ssets/[Ss]treamingAssets/aa/*
+/[Aa]ssets/[Ss]treamingAssets/aa/*
+
+# DocFX
+.cache
+/**/_site/
+/**/apidocs

Assets/Scripts/API/ServerConnectionController.md

@@ -0,0 +1,28 @@
+# ServerConnection
+
+This class manages the connection to a server for synchronizing room state.
+
+## Public Properties
+
+-   `hostname`: The hostname of the server.
+-   `roomId`: The ID of the room.
+-   `updateToken`: The token used for updating the room state.
+-   `instance`: A static instance of the ServerConnection class.
+
+## Public Methods
+
+-   `void Awake()`
+    -   Ensures there's only one ServerConnection object.
+-   `void Update()`
+
+## Private Fields
+
+-   `lastSync`: Stores the last synchronization time.
+-   `SYNC_FREQUENCY_MS`: Defines the synchronization frequency in milliseconds.
+
+## Private Methods
+
+-   `async Task getAndUseRoomState()`
+    -   Fetches the room state and sets settings and equations appropriately.
+-   `async Task<Boolean> pushRoomState(ParseTreeNode[] parseTrees, GraphSettings graphSettings)`
+    -   Pushes the equations (token parse trees) and the room settings to the server.

Assets/Scripts/API/ServerConnectionController.md.meta

@@ -0,0 +1,77 @@
+# API Response Classes
+
+This file defines the JSON response structures expected from various API endpoints.
+
+## API_Response\<T>
+
+A generic class representing a standard API response.
+
+### Generic Type Parameter
+
+-   `T`: The type of the data field.
+
+### Public Fields
+
+-   `T data`: The data returned by the API.
+-   `string error`: An error message, if any.
+
+## API_GET_RoomState
+
+Represents the JSON response for retrieving room state.
+
+### Public Fields
+
+-   `RoomInfo_RoomState data`: The room state data.
+
+## API_POST_RoomState
+
+Represents the JSON structure for posting room state.
+
+### Public Fields
+
+-   `string key`: The update key.
+-   `RoomInfo_RoomState roomState`: The room state to be posted.
+
+## API_POST_CreateResult
+
+Represents the JSON response for creating a room.
+
+### Public Fields
+
+-   `RoomInfo data`: The room information.
+
+## API_ServerPingResponse
+
+Represents the JSON response for a server ping.
+
+### Public Fields
+
+-   `string status`: The server status.
+-   `int protocolVersion`: The server's protocol version.
+
+## RoomInfo
+
+Represents information about a room.
+
+### Public Fields
+
+-   `string roomId`: The room ID.
+-   `string ownerUpdateToken`: The owner's update token.
+-   `RoomInfo_RoomState roomState`: The room's state.
+
+## RoomInfo_RoomState
+
+Represents the state of a room.
+
+### Public Fields
+
+-   `GraphSettings settings`: The graph settings.
+-   `ParseTreeNode[] equations`: An array of parse tree nodes representing equations.
+
+## ACCEPTED_PROTOCOL
+
+A static class defining the accepted protocol version.
+
+### Public Constants
+
+-   `int VERSION`: The accepted protocol version.

Assets/Scripts/API/VREFServerJSON.md

@@ -0,0 +1,4 @@
+- name: ServerConnectionController
+  href: ServerConnectionController.md
+- name: VRefServerJSON
+  href: VRefServerJSON.md

Assets/Scripts/API/VREFServerJSON.md.meta

@@ -0,0 +1,15 @@
+# EquationToken
+
+Represents a token within an equation.
+
+## Public Properties
+
+-   `string text`: The text of the token.
+-   `TokenType type`: The type of the token.
+
+## Public Methods
+
+-   `EquationToken(string text, TokenType type)`
+    -   Constructor for the EquationToken class. Initializes the text and type of the token.
+-   `string ToJSON()`
+    -   Converts the EquationToken to a JSON string representation.