arfc / moltres

Repository for Moltres, a code for simulating Molten Salt Reactors
GNU Lesser General Public License v2.1
66 stars 41 forks source link

Set up new website built on MooseDocs system #199

Closed smpark7 closed 2 years ago

smpark7 commented 2 years ago

This PR addresses some tasks in issues #179 and #193 involving documentation and website setup. The changes include:

The task of building MooseDocs html files requires us to compile Moltres in the GitHub Action. This takes 30 minutes to run but I think it's better to exploit computational resources for reliability than having someone (aka me) build it locally and push to gh-pages every time there's a change to the docs.

Refer to https://smpark7.github.io/moltres/ to see how the website will actually look like.

For clarity, future tasks (already tracked in meta-issue #179) include:

yardasol commented 2 years ago

Hi @smpark7, great work here! I'm going to get around to this PR quite soon (today), but I wanted to ask, have you added instructions on how to build the documentation manually? Or does said instructions already exist?

smpark7 commented 2 years ago

Thanks @yardasol! My intention here was for users to not have to build it manually. Hence the changes to the gh-pages Action to automatically build and deploy the website. So I don't have the instructions here.

I suppose it could be helpful for future developers in the event that they have to debug gh-pages Action due to dependency issues or some other causes. Let me know if you feel that the instructions are necessary.

yardasol commented 2 years ago

I strongly recommend adding a guide on how to manually build the docpages. One could look at the GH action to figure out how, but this isn't very user friendly. Like you said, being able to build manually helps debug gh-pages action, but it also allows users to test out how the docs look if/when they add a new feature.

smpark7 commented 2 years ago

@yardasol I added a "Contributing" page which includes instructions on how to contribute to Moltres and how to manually build the docpages. I also added a "Publications page that provides a list of publications which used Moltres.

I replaced the "Source documentation" page with a "Syntax" page which contains the same documentation links and also adds new links for each general class type (e.g. Kernels, BCs, etc.). The class type links lead directly to MOOSE-provided documentation which uses many of the large media files you found. I think this implementation is fair because MOOSE already provides good documentation for these kinds of MOOSE-wide features.

This PR is ready for another review. The preview website at https://smpark7.github.io/moltres/ will be ready once the gh-pages action finishes running on my fork https://github.com/smpark7/moltres/runs/6298699903?check_suite_focus=true.

smpark7 commented 2 years ago

@munkm This is ready for your review. I incorporated your suggestions for reordering the list of publications by date and recommending git merge instead of git rebase. I hope to merge soon-ish because yet another person has had trouble with the outdated installation instructions #202. Thank you!

munkm commented 2 years ago

Thanks for the reminder @smpark7 ! I'm on it.

smpark7 commented 2 years ago

Thank you!