I suggest adding a quick overview of the capabilities of the tool to README.md.
In the same way I suggest adding an overview of the capabilities to the top of the file /docs/source/index.rst.
In the section "What is F4Enix" of the file /docs/source/usage/introduction.rst I suggest to reorganise the information for better clarity, e.g., per code/file (MCNP - Input).
I suggest to group and shorten the headings in the documentation navigation pane (F4Enix usage examples). E.g., from "Working with MCNP input files" to "MCNP input",...
I suggest adding additional subsections to the documentation, which will allow for quick identification of where one capability ends and the other starts. For example, if I open "Working with MCNP MESHTAL file", I have to read through the code to understand what can be done with F4Enix.
Is the information available in the doc but not where you would expect?
The information is scattered all around the documentation.
Is information completely lacking or partial?
README.md does not contain any overview of capabilities of the tool, while in the documentation the information is scattered all around.
Where would you insert the missing information?
Into the introduction in README.md and in documentation.
What where you looking for
Few suggestions regarding documentation:
Is the information available in the doc but not where you would expect?
The information is scattered all around the documentation.
Is information completely lacking or partial?
README.md does not contain any overview of capabilities of the tool, while in the documentation the information is scattered all around.
Where would you insert the missing information?
Into the introduction in README.md and in documentation.
Additional context
N/A.