Better docs (#48)

Author: Enn3Developer

.github/workflows/docs.yaml

@@ -0,0 +1,47 @@
+# Trigger the action on push to master
+on:
+  push:
+    branches:
+      - master
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  actions: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  publish-docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Dotnet Setup
+        uses: actions/setup-dotnet@v3
+        with:
+          dotnet-version: 8.x
+
+      - run: dotnet tool update -g docfx
+      - run: |
+          cd OpenPolytopia.Common
+          dotnet build
+          cd ..
+          docfx docs/docfx.json
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: 'docs/_site'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

OpenPolytopia.Common/City.cs

@@ -5,6 +5,9 @@ namespace OpenPolytopia.Common;
 using System.Runtime.CompilerServices;
 using Godot;
 
+/// <summary>
+/// Layer of abstraction to manage all cities in a grid
+/// </summary>
 public class CityManager(Grid grid) {
   private readonly List<uint> _cities = [];
 
@@ -28,13 +31,25 @@ public CityData this[uint id] {
   /// </summary>
   /// <param name="id">the id of the city</param>
   /// <returns>the id of the tile in the grid</returns>
+  /// <example>
+  /// <code>
+  /// var index = cityManager.GetIndex(cityId);
+  /// grid[index].Owner = 2;
+  /// </code>
+  /// </example>
   public uint GetIndex(uint id) => _cities[(int)(id - 1)];
 
   /// <summary>
   /// Registers a tile as a city
   /// </summary>
   /// <param name="position">position of the tile in the grid</param>
   /// <returns>the id of the city</returns>
+  /// <example>
+  /// <code>
+  /// var position = new Vector2I(0, 5);
+  /// var cityId = cityManager.RegisterCity(position);
+  /// </code>
+  /// </example>
   [MethodImpl(MethodImplOptions.AggressiveInlining)]
   public uint RegisterCity(Vector2I position) => RegisterCity(grid.GridPositionToIndex(position));
 
@@ -44,6 +59,13 @@ public CityData this[uint id] {
   /// <param name="index">index of the tile in the grid</param>
   /// <returns>the id of the city</returns>
   /// <exception cref="ArgumentOutOfRangeException">because of internal implementation, there can only be 255 cities</exception>
+  /// <example>
+  /// <code>
+  /// var position = new Vector2I(0, 5);
+  /// var index = grid.GridPositionToIndex(position);
+  /// var cityId = cityManager.RegisterCity(index);
+  /// </code>
+  /// </example>
   public uint RegisterCity(uint index) {
     if (_cities.Count == 255) {
       throw new ArgumentOutOfRangeException(nameof(index), index, "reached maximum cities possible; max is 255");

OpenPolytopia.Common/OpenPolytopia.Common.csproj

@@ -4,6 +4,7 @@
     <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

OpenPolytopia.Common/Tribe.cs

@@ -23,6 +23,15 @@ public class TribeManager {
   /// </summary>
   /// <param name="type">the type of the tribe</param>
   /// <param name="tribe">the data of the tribe</param>
+  /// <example>
+  /// <code>
+  /// var imperiusTribe = new Tribe {
+  ///   // settings for this tribe
+  /// };
+  /// var tribeManager = new TribeManager();
+  /// tribeManager.RegisterTribe(TribeType.Imperius, imperiusTribe);
+  /// </code>
+  /// </example>
   public void RegisterTribe(TribeType type, Tribe tribe) => Tribes.Add(type, tribe);
 
   /// <summary>
@@ -36,9 +45,23 @@ public void RegisterTribes(TribesSerializedData tribes) {
   }
 }
 
+/// <summary>
+/// Class representing all data a tribe has
+/// </summary>
 public class Tribe {
+  /// <summary>
+  /// The starting tech of a tribe
+  /// </summary>
   public required StartingTech StartingTech { get; init; }
+
+  /// <summary>
+  /// The resource spawn rates of a tribe
+  /// </summary>
   public required SpawnRate SpawnRate { get; init; }
+
+  /// <summary>
+  /// The terrain generation rates of a tribe
+  /// </summary>
   public required TerrainRate TerrainRate { get; init; }
 }
 

OpenPolytopia/OpenPolytopia.csproj

@@ -19,14 +19,15 @@
     <Title>OpenPolytopia</Title>
     <Version>0.1.0</Version>
     <Description>OpenPolytopia</Description>
-    <Copyright>© 2024 Enn3DevPlayer, GamerPlayer888, Remoxx</Copyright>
-    <Authors>Enn3DevPlayer, GamerPlayer888, Remoxx</Authors>
-    <Company>Enn3DevPlayer, GamerPlayer888, Remoxx</Company>
+    <Copyright>© 2024 Enn3DevPlayer, GamerPlayer888, Remoxx, C0MPL3XDEV</Copyright>
+    <Authors>Enn3DevPlayer, GamerPlayer888, Remoxx, C0MPL3XDEV</Authors>
+    <Company>Enn3DevPlayer, GamerPlayer888, Remoxx, C0MPL3XDEV</Company>
     <!-- Don't include unit tests in release builds. -->
     <DefaultItemExcludes Condition="'$(Configuration)' == 'ExportRelease'">
       $(DefaultItemExcludes);test/**/*
     </DefaultItemExcludes>
     <TargetFramework>net8.0</TargetFramework>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
   <ItemGroup Condition=" '$(Configuration)' == 'Debug' or '$(Configuration)' == 'ExportDebug' ">
     <!-- Test dependencies go here! -->
@@ -60,4 +61,4 @@
     <ProjectReference Include="..\FSharpLibrary\FSharpLibrary.fsproj"/>
     <ProjectReference Include="..\OpenPolytopia.Common\OpenPolytopia.Common.csproj"/>
   </ItemGroup>
-</Project>
+</Project>

StdbModule/StdbModule.csproj

@@ -7,6 +7,7 @@
     <Nullable>enable</Nullable>
     <RootNamespace>OpenPolytopia.Server</RootNamespace>
     <OutputType>Exe</OutputType>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
 
   <ItemGroup>

docs/.gitignore

@@ -0,0 +1,2 @@
+_site/
+api/

docs/docfx.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://raw.githubusercontent.com/dotnet/docfx/main/schemas/docfx.schema.json",
+  "metadata": [
+    {
+      "src": [
+        {
+          "src": "../.",
+          "files": [
+            "**/OpenPolytopia.Common/bin/Debug/**.dll"
+          ]
+        }
+      ],
+      "dest": "api"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "**/*.{md,yml}"
+        ],
+        "exclude": [
+          "_site/**"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "output": "_site",
+    "template": [
+      "default",
+      "modern"
+    ],
+    "globalMetadata": {
+      "_appName": "OpenPolytopia",
+      "_appTitle": "OpenPolytopia",
+      "_enableSearch": true,
+      "pdf": false
+    }
+  }
+}

docs/docs/getting-started.md

@@ -0,0 +1 @@
+# Getting Started

docs/docs/introduction.md

@@ -0,0 +1 @@
+# Introduction