Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 5 additions & 9 deletions .github/workflows/push-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
- name: Checkout docs
uses: actions/checkout@v6
with:
path: docs
path: docs-repo
repository: nanoforge-dev/docs
token: ${{ secrets.ACTIONS_KEY }}

Expand All @@ -43,21 +43,17 @@ jobs:
git config --global user.name "github-actions[bot]"
git config --global user.email "username@users.noreply.github.com"

- name: install doxygen
uses: ssciwr/doxygen-install@v2

- name: install deps
run: cd engine && pnpm i

- name: synchronize docs
run: |
cd engine
./scripts/build_docs.sh
pnpm run docs
cd ..
rm docs/engine -rf
mkdir -p docs/engine
cp -r engine/docs/* docs/engine
cd docs
mkdir -p docs-repo/docs/engine
rsync -av engine/docs/* docs-repo/docs/engine/
cd docs-repo
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"
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -236,3 +236,5 @@ docs/ecs-lib/api/typescript.md


emsdk-cache/
.vscode
.tsdocs
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ coverage/
CHANGELOG.md

emsdk-cache/
docs/api
2 changes: 1 addition & 1 deletion docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1 +1 @@
Doxyfile
api
7 changes: 0 additions & 7 deletions docs/asset-manager/index.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/common/index.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/config/index.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/core/index.rst

This file was deleted.

11 changes: 11 additions & 0 deletions docs/documentation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: "Documentation"
icon: "book"
description: "Overview of the engine documentation"
---

# Documentation

The documentation for the engine is separated across the different libraries of the engine. Everything is then gathered into this site and published from the repository automatically.

This documentation is written in reStructuredText and is now being migrated to MDX so it is easier to maintain alongside the rest of the site. Sphinx is used to generate the rendered documentation.
7 changes: 0 additions & 7 deletions docs/documentation.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/ecs-client/index.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/ecs-lib/index.rst

This file was deleted.

11 changes: 0 additions & 11 deletions docs/ecs-lib/wasm.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/ecs-server/index.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/graphics-2d/index.rst

This file was deleted.

17 changes: 17 additions & 0 deletions docs/how_to_use.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Introduction to using the Engine"
icon: "book"
description: "Getting started with the engine"
---

# Introduction to using the Engine

Whether you work on this engine as a developer or you want to use it, you will want a test project. This page is a walkthrough for setting up a basic project.

## As a developer on the engine

As a developer you want to be able to use your changes in your own project. Therefore it is recommended to use the provided [CLI](https://github.com/NanoForge-dev/CLI).

## As a user

As a user you can either use the template and change the dependency location, or create a project and add the Nanoforge dependencies. It is recommended to use Bun as a package manager.
20 changes: 0 additions & 20 deletions docs/how_to_use.rst

This file was deleted.

32 changes: 32 additions & 0 deletions docs/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: "Engine"
icon: "book"
description: "Nanoforge engine documentation"
---

# Engine

This documentation covers the engine, its packages, and the surrounding usage guides.

## Start Here

- [Documentation](documentation.mdx)
- [How to Use](how_to_use.mdx)

## Packages

- [Registry](registry/index.mdx)
- [Network](network/index.mdx)
- [Asset Manager](asset-manager/index.mdx)
- [Common](common/index.mdx)
- [Config](config/index.mdx)
- [Core](core/index.mdx)
- [ECS Client](ecs-client/index.mdx)
- [ECS Server](ecs-server/index.mdx)
- [ECS Lib](ecs-lib/index.mdx)
- [Graphics 2D](graphics-2d/index.mdx)
- [Input](input/index.mdx)
- [Music](music/index.mdx)
- [Sound](sound/index.mdx)
- [Network Client](network-client/index.mdx)
- [Network Server](network-server/index.mdx)
25 changes: 0 additions & 25 deletions docs/index.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/input/index.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/music/index.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/network-client/index.rst

This file was deleted.

7 changes: 0 additions & 7 deletions docs/network-server/index.rst

This file was deleted.

23 changes: 23 additions & 0 deletions docs/network/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
title: "Network Overview"
icon: "book"
description: "Overview of the engine networking docs"
---

# Network Overview

This page describes the engine's networking libraries: `network-server` and `network-client`. Together they provide a small, pragmatic networking layer used by the example `pong-network` game.

## Goals

- Keep the protocol minimal and predictable for multiplayer games.
- Use well-understood transports: TCP for reliable control messages and UDP for low-latency, best-effort state updates.
- Provide clear validation hooks such as magic values and versioning so malformed packets are ignored early.

## Related Pages

- [Network Client](network-client.mdx)
- [Network Server](network-server.mdx)
- [Packet Framing](packet-framing.mdx)
- [Network Server API](network-server-api.mdx)
- [Network Client API](network-client-api.mdx)
76 changes: 0 additions & 76 deletions docs/network/index.rst

This file was deleted.

Loading
Loading