CICE-Consortium / Icepack

Development repository for sea-ice column physics
Other
25 stars 131 forks source link

Add Tutorial to User Guide as Appendix #485

Closed apcraig closed 4 months ago

apcraig commented 4 months ago

PR checklist

Add the tutorial to the user guide as an appendix. Allows for easy links into the rest of the documentation and gives it a permanent and accessible home. The icepack variable name table was also moved to the new appendix section.

apcraig commented 4 months ago

Should the appendices be after or before the references?

dabail10 commented 4 months ago

Should the appendices be after or before the references?

I don't really have a preference.

eclare108213 commented 4 months ago

These appendices make most sense before the references, in my opinion. This is awesome, thank you very much. I do (as usual) have quite a few little tweaky grammar kinds of things. I'll clone the branch...

apcraig commented 4 months ago

We could also get rid of the formal rst subsections (6.2.1, 6.2.2, etc) and just make those bolded (or similar) headings in the tutorial. That would remove them from the table of contents. I'm not sure they each deserve a separate rst section/heading.

eclare108213 commented 4 months ago

I like how visible the subsections are in the text, and I don't mind them showing up in the table of contents. I'm attempting to edit/commit directly in github. Let me know if you think that's a bad idea... seems like it will work.

apcraig commented 4 months ago

editing and committing in github is fine. individual commits are created just like if you did it in a sandbox.

apcraig commented 4 months ago

Everything looks good to me. Any other comments/changes?