Home

This project utilizes mkdocs and its material theme to build deliver a documentation overview of the many projects here at FutureHax.

Each project should deploy its own documentation into the docs/projects/ directory on the server itself, not this repository. This project just sets up any skeleton framework for the documentation server, and provides documentation for general information that would not be contained in any specific project repo.

When a new project is created, a few steps need to be followed to have the docs fully integrated. Future plans include a way to automate this, but for now the steps are manual.

  • Deploy the project docs to the server under /srv/docs/<PROJECT_NAME>
  • Update docs/projects/index.md and add a small overview of the project
  • Update mkdocs.yml at .nav and include the project and path to the main index.md

Please view the External Wiki for more.

Last update: 2023-10-31