What is this task about?
@ConnorWelch-OSU and I were discussing adding a Structure and Syntax page to the tutorials before the sim_parm.rst. There is a lot of miscellaneous information in the current tutorials that is important and could be shoved in here. Some examples that we have seen include
- Footnote mentioning xml block ordering
- the
Note at the end of the simulation parameters page about the ending tag etc
- Commodity block being optional
- No hyphens
- Capitalization specifications for tags/names matters
- any syntax related, structural, Cyclus specific stuff
It could be thought of as a mini-rule/guide book before going into the tutorials. This information seems pretty relevant but may get lost.
Why is this task needed?
This task could contribute to issue #442 and could centralize some important but less FC related information.
This is just a small idea and maybe could be handled without a whole separate tutorial page. Other option could include making all offhanded information that is important footnotes for consistency.
What is this task about?
@ConnorWelch-OSU and I were discussing adding a
Structure and Syntaxpage to the tutorials before thesim_parm.rst. There is a lot of miscellaneous information in the current tutorials that is important and could be shoved in here. Some examples that we have seen includeNoteat the end of the simulation parameters page about the ending tag etcIt could be thought of as a mini-rule/guide book before going into the tutorials. This information seems pretty relevant but may get lost.
Why is this task needed?
This task could contribute to issue #442 and could centralize some important but less FC related information.
This is just a small idea and maybe could be handled without a whole separate tutorial page. Other option could include making all offhanded information that is important footnotes for consistency.