docs: setup typedoc

.github/workflows/push-docs.yml

@@ -26,22 +26,39 @@ jobs:
           repository: nanoforge-dev/docs
           token: ${{ secrets.ACTIONS_KEY }}
 
+      - name: Install Node.js v24
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          package-manager-cache: false
+          registry-url: https://registry.npmjs.org/
+
+      - uses: pnpm/action-setup@v4.1.0
+        name: Install pnpm
+        with:
+          run_install: false
+          version: 10.22.0 # Couldnt find a way to execute this action in the right directory
+
       - name: setup git
         run: |
           git config --global user.name "github-actions[bot]"
           git config --global user.email "username@users.noreply.github.com"
 
-      - name: setup registry code documentation
-        uses: mattnotmitt/doxygen-action@v1
-        with:
-          doxyfile-path: engine/packages/ecs-lib/docs/Doxyfile
+      - name: install doxygen
+        uses: ssciwr/doxygen-install@v1
+
+      - name: install deps
+        run: cd engine && pnpm i
 
       - name: synchronize docs
         run: |
-          cp -r engine/packages/ecs-lib/docs engine/docs/registry/api
+          cd engine
+          ./scripts/build_docs.sh
+          cd ..
+          rm docs/engine -rf
           mkdir -p docs/engine
           cp -r engine/docs/* docs/engine
           cd docs
-          git add .
-          git commit -m "chore(engine): updating docs"
-          git push origin main
+          git add . || echo "No changes to add"
+          git commit -m "chore(engine): updating docs" || echo "No changes to commit"
+          git push origin main || echo "No changes to push"

.gitignore

@@ -227,3 +227,9 @@ dist
 .turbo/
 
 compile_commands.json
+docs_markdown
+xml
+docs_build
+docs/conf.py
+docs/*/api/index.md
+docs/ecs-lib/api/typescript.md

docs/asset-manager/index.rst

@@ -0,0 +1,7 @@
+asset-manager
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/common/index.rst

@@ -0,0 +1,7 @@
+common
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/config/index.rst

@@ -0,0 +1,7 @@
+config
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/core/index.rst

@@ -0,0 +1,7 @@
+core
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/ecs-client/index.rst

@@ -0,0 +1,7 @@
+ecs-client
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/ecs-lib/index.rst

@@ -0,0 +1,8 @@
+ECS Documentation
+=================
+
+.. toctree::
+
+
+  wasm.rst
+  api/typescript.rst

docs/ecs-lib/wasm.rst

@@ -0,0 +1,11 @@
+C++ classes
+-----------
+
+.. doxygenclass:: nfo::Registry
+    :members:
+
+.. doxygenclass:: nfo::Entity
+    :members:
+
+.. doxygenclass:: nfo::SparseArray
+    :members:

docs/ecs-server/index.rst

@@ -0,0 +1,7 @@
+ecs-server
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/graphics-2d/index.rst

@@ -0,0 +1,7 @@
+graphics-2d
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/index.rst

@@ -2,11 +2,24 @@ Engine
 ======
 
 .. toctree::
-    :maxdepth: 2
 
-    registry
     documentation.rst
     how_to_use.rst
+    registry/index.rst
+    network/index.rst
+    asset-manager/index.rst
+    common/index.rst
+    config/index.rst
+    core/index.rst
+    ecs-client/index.rst
+    ecs-server/index.rst
+    ecs-lib/index.rst
+    graphics-2d/index.rst
+    input/index.rst
+    music/index.rst
+    sound/index.rst
+    network-client/index.rst
+    network-server/index.rst
 
 In this doc you will find both the how to use and why use this engine as well as its library.
 To understand how to use this engine please refer to :doc:`/how_to_use`

docs/input/index.rst

@@ -0,0 +1,7 @@
+input
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/music/index.rst

@@ -0,0 +1,7 @@
+music
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/network-client/index.rst

@@ -0,0 +1,7 @@
+network-client
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/network-server/index.rst

@@ -0,0 +1,7 @@
+network-server
+==================
+
+.. toctree::
+
+
+   api/index.md

docs/network/index.rst

@@ -1,6 +1,14 @@
 Network Overview
 ================
 
+.. toctree::
+
+    network-client
+    network-server
+    packet-framing
+    network-server-api
+    network-client-api
+
 This page describes the global design and rationale for the engine's networking
 libraries: the `network-server` and `network-client` TypeScript packages. These
 libraries provide a small, pragmatic networking layer used by the example

docs/network/network-client.rst

@@ -17,7 +17,7 @@ Client responsibilities in a game are typically:
   or sending low-latency updates.
 
 Example
---------------------------------------------------
+-------
 
 It works exactly the same with UDP
 

docs/registry/index.rst

@@ -2,7 +2,7 @@ Registry
 ========
 
 .. toctree::
-    :maxdepth: 2
+
 
     writing_web_assembly.rst
 

docs/sound/index.rst

@@ -0,0 +1,7 @@
+sound
+==================
+
+.. toctree::
+
+
+   api/index.md

package.json

@@ -44,6 +44,8 @@
     "prettier": "^3.6.2",
     "tsup": "^8.5.1",
     "turbo": "^2.6.1",
+    "typedoc": "^0.28.16",
+    "typedoc-plugin-markdown": "^4.9.0",
     "typescript": "^5.9.3",
     "vitest": "^4.0.15"
   },

packages/asset-manager/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "skipErrorChecking": true
+}

packages/common/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "skipErrorChecking": true
+}

packages/config/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "skipErrorChecking": true
+}

packages/core/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "skipErrorChecking": true
+}

packages/ecs-client/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "skipErrorChecking": true
+}

packages/ecs-lib/docs/index.rst

@@ -2,7 +2,7 @@ ECS Documentation
 =================
 
 .. toctree::
-  :maxdepth: 2
 
-  wasm
-  typescript
+
+  wasm.rst
+  api/typescript.rst

packages/ecs-lib/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "skipErrorChecking": true
+}

packages/ecs-server/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "skipErrorChecking": true
+}

packages/graphics-2d/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "skipErrorChecking": true
+}

packages/input/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "skipErrorChecking": true
+}

packages/music/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "skipErrorChecking": true
+}

packages/network-client/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "skipErrorChecking": true
+}

packages/network-server/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "skipErrorChecking": true
+}

packages/sound/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../../typedoc.base.json"],
+  "entryPoints": ["src/index.ts"],
+  "skipErrorChecking": true
+}