gbadoc

Community initiated GBA Technical documentation effort.

We're currently in the early stages. Join the discussions on RFCs and first content in the Issues and join the #documentation chat channel on the gbadev discord.

Building the documentation

The book is written in markdown and compiled to HTML using mdbook. It's a tool written in Rust, but you do not have to have Rust installed to use it. There are pre-built binaries available.

Basic usage:

• mdbook serve: builds the book and serves it at http://localhost:3000. This will continue to watch the files while it's serving. Any changes on disk will automatically trigger a new build, and you'll see the changes just by refreshing your browser.
• mdbook serve --open: as above, but this also opens a browser tab to the correct URL for you.