·Aether Team

Announcing the Aether Documentation Site

announcement

We are excited to announce the launch of the official Aether documentation site. Whether you are a first-time user exploring the engine or an experienced contributor diving into a specific subsystem, this site is designed to help you find what you need quickly.

Why We Built It

As Aether has grown to 26 crates spanning six domains, the need for a centralized, well-organized documentation hub became clear. Design documents in the repository are invaluable for contributors, but they are not the best format for onboarding new users or discovering features across the engine.

This documentation site addresses those gaps:

  • Better onboarding. New users can follow step-by-step getting started guides instead of piecing together information from scattered README files and source comments.
  • Discoverability. With content organized by domain (Core Engine, Scripting, World, Social, Platform, Safety), it is straightforward to find the crate or feature you need.
  • Living reference. API reference pages are structured around real usage patterns, not just auto-generated type listings.

What's Included

The site launches with four main sections:

  • Getting Started -- Installation, first project setup, and a walkthrough of the interactive 3D demo.
  • Guides & Tutorials -- Focused walkthroughs on topics like ECS basics, physics integration, visual scripting, and multiplayer networking.
  • API Reference -- Crate-by-crate documentation for all 26 Aether crates, organized by domain with usage examples.
  • Changelog -- A versioned history of features, improvements, and fixes for every release.

Feedback

If you spot an error or have suggestions for improving the documentation, please open an issue on the Aether repository. We value your feedback and use it to keep the docs accurate and helpful.

What's Coming Next

This initial launch is just the beginning. Here is what we are working on next:

  • Interactive examples -- Embedded, runnable code snippets directly in the documentation.
  • Architecture deep dives -- Detailed articles on the ECS internals, networking stack, and rendering pipeline.
  • Video tutorials -- Companion videos for the most popular guides.
  • Search -- Full-text search across all documentation content.
  • Localization -- Community-driven translations for non-English speakers.

We hope this site makes your experience with Aether smoother and more productive. If you have feedback or suggestions, please open an issue on the Aether GitHub repository or join the discussion on GitHub Discussions.

Happy building.