The main static website for aurae.io.
Do not edit documentation in this repository. Instead, find the corresponding /docs folder in each repository you intend on adding documentation to.
For example if you intend on editing a file for the auraed project find the auraed/docs directory and open a pull request against that specific project.
The maintainers of each project will review your change.
Additionally there is a top level set of documentation in the main aurae repository.
The website is built using
material-mkdocs which is a
Markdown flavor and a fork of mkdocs. material-mkdocs provides features like
embedding scriptable diagrams using mermaid.
Create a new page in the /docs folder and add the filename to the nav list
in mkdocs.yml.
The page will then be added to the main menu of the page.
The website is updated upon a merge to main and you can follow the deployment process under the Actions and check for potential build errors.
run.sh allows you to work on the documentation locally. run.sh will launch a
docker container that will build the documentation and host it on a local web
server. The development server runs on port 8000 and will automatically pick up
on changes to the documentation, however it will not refresh the browser
page automatically.
| Record | Value |
|---|---|
| A Record | 185.199.108.153 185.199.109.153 185.199.110.153 185.199.111.153 |
| AAAA Record | 2606:50c0:8000::153 2606:50c0:8001::153 2606:50c0:8002::153 2606:50c0:8003::153 |
| CNAME www.aurae.io | aurae-runtime.github.io |