This repository exists to support a GitHub Pages website for the documentation of all open-source TerraPower projects. For instance, at the time of this writing, this repo represents the projects:
- armi
- armicontrib-dif3d
- dragon-plugin
The primary documentation pages will be for the bleeding-edge, latest-and-greatest version of each repository/project. But as important releases happen, we will also append the versioned, official releases of the documentation too. For instance:
The default, top-level documentation in this repo (for instance, the top-level /armi/ folder) is used for the most recent, up-to-date, bleeding-edge version of the software. But every time a major/minor release happes, our release process is to immediately archive off the documentation for that software.
The process to archive docs is easy.
Let's say the ARMI package has just released version 1.0.0. Hurray! After waiting a few minutes, the documentation for that version will be automatically deployed by a GitHub Action job here, to the top-level /armi/ folder. To archive the documentation for that release, simply copy/paste the entire documenation folder to: /releases/armi/v1.0.0/. Done!
For extra points, please add a link to your new documentation in the top-level index.html file.