terrapower / terrapower.github.io Goto Github PK

It appears that the 'Edit on GitHub' links at the top-right of many of the doc pages are broken. Not all of them are broken, for instance the ones on the home page, installation page, and tutorials page work. But at least the following ones are broken (and likely many others):

• gallery
• physics package
• neutronics package
• energyGroups module

The issue, as I see it, is that we have terrapower.github.io pointing to a 404 page, but there are three subpages where are valid:

• terrapower.github.io/armi/
• terrapower.github.io/armicontrib-dif3d/
• terrapower.github.io/dragon-plugin/

So, we just need a front page. Simple.

I also think this is important as I would like to add "old versions of the docs" that we copy/paste over manually. Something like:

• terrapower.github.io/releases/armi/v0.2.0/
• terrapower.github.io/releases/dragon-plugin/v1.0.0/

The instructions for installation under the quick start guide includes the following command line snip-it.

$ git clone https://github.com/terrapower/armi
$ pip install -r requirements.txt
$ python setup.py install
$ armi

However, following these instructions explicitly will result in a file not found error when performing pip install -r requirements.txt since the requirements.txt is within the armi folder. This can be alleviated by instructing the user to cd into the armi folder before attempting to perform the pip install -r requirements.txt step.

This should also be clarified under the the installation chapter of the user guide.