terrapower / armi

An open-source nuclear reactor analysis automation framework that helps design teams increase efficiency and quality
https://terrapower.github.io/armi/
Apache License 2.0
224 stars 87 forks source link

Add more prominent grid editor docs with image. #1731

Closed ntouran closed 3 months ago

ntouran commented 3 months ago

The grid editor is a powerful feature, and not easy to discover or featured in the docs. This adds an intriguing figure (from our fftf isothermal repo) up front so people can see what they're missing and go looking for the feature.

image

Along the way, I noticed that all png files were ignored across the repo. Since we use png images in our documentation, it's important that we do not blanket ignore such files. I struggled for a while to find out why my png wasn't showing up in the options to stage! If we have build artifacts that are ending up in commits then I suggest we clean those out or be more precise with the ignoring.

Why is the change being made?

This was discussed in https://github.com/terrapower/armi/discussions/1722


Checklist