All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add, astro check |
npm run astro -- --help |
Get help using the Astro CLI |
Check out Starlight’s docs, or read the Astro documentation, it might explain what you're trying to do.
If you can't find what, feel free to ping Theta in #📝│au-wiki, they might know.
For the most part, you should be able to preview your documentation in any markdown viewer, however if you want to see how it looks on the actual website, you will need to host it locally.
For this, you will need to install Node.js. It's highly recommended to use NodeJS v24.x.x, however v22.x.x may be used at a minimum.
If you've already installed NodeJS, you can view the installed version in your terminal by doing node -v. If you're on a version above or including v22/v24, you should be good.
Once you've installed Node, you can clone the repository and run npm i in a terminal in the root directory of the project. Once that finishes, you should be able to run npm run dev to run the website locally. You can then visit http://localhost:4321 in your browser to preview the website.
If you want to contribute to the documentation, please reach out first in the All Of Us discord first, in the #📝│au-wiki channel.
Please note that use of AI for anything other than spellchecking & formatting is highly discouraged and unless good reason is given, your contribution may be reverted or denied if it's a PR.
We want to keep the documentation high quality, and AI simply has a lot of misinformation about the game.
For now, all information contained in the documentation will be mainly about the base game; this may be expanded in the future to cover popular APIs like Reactor or MiraAPI, however this is not the case for now.