Skip to main content

Getting Started

aphyn is a Rust game engine workspace. This page is a small preview of the future conceptual documentation.

The full documentation should grow from the source code outward: public APIs first, then architecture notes, then guides for common extension points.

Local Build​

From the repository root, build the Rust workspace with:

cargo build

Documentation Shape​

The long-term documentation can be split into:

  • Docs for concepts, architecture, and task-oriented guides.
  • API Reference for crate, module, type, trait, and function-level material generated or derived from Rust source.

This test page exists to validate the Docusaurus layout, navigation, and GitHub Pages deployment before generating the real content.