Documentation at railbird

We use mkdocs with the material theme

We use mkdocs with the material theme to write our documentation.

Docs are built automatically through CI

The canonical git repository is configured to automatically update the documentation at docs.railbird.ai whenever we merge new comits to master.

Previewing Docs

Run

mkdocs serve --watch-theme

Pages should be added to naviagation

Make sure to remember to add any newly created pages to mkdocs.yml