Documentation - confusing? missing? improvements? Let us know!

[dlebauer]

Please leave a comment if you find any errors or opportunities to improve the documentation.

• out of date content
• missing content
• useful content that is hard to find / in the wrong place
• unclear instructions
• unclear organization
• any other improvements.

FAQ:

1. Q: shouldn't I just fix the docs instead of reporting it here
   A: that would be great, but adding a comment here should be easier if you don't have time
2. Q: well shouldn't I at least create an issue and tag it #documentation?
   A: see answer to 1.
3. Q: What information should I include?
   A: Url, what you saw, what should change, and link to the section
   note: (right-click the header and copy link; it should include the page and section like input-standards.html#dimensions, not just https://pecanproject.github.io/pecan-documentation/develop/input-standards.html#dimensions
4. Q: Isn't there already a discussion thread on improving documentation?
   A: Yes, that's Reorganizing documentation #3688. But that has a higher level focus. This thread is for specific issues.
5. Q: What should I do if someone has fixed an issue listed here?
   A: leave a comment that it has been fixed, maintainers can mark the comment as outdated.

[dlebauer]

Standard vars table at https://pecanproject.github.io/pecan-documentation/develop/input-standards.html#dimensions

1. has <br> tags
2. doesn't need links to download; a link to the source CSV in GitHub would be sufficient.

[dlebauer]

On https://pecanproject.github.io/pecan-documentation/develop/input-standards.html#soils-and-vegetation-inputs

• Soils and vegetation links self-reference, and there is no content. Content should be added to the same page
• remove "10.3.2 Soils and Vegetation Inputs" and put Soils and Vegetation at the same level (h3?) as met.

[ayushman1210]

https://github.com/PecanProject/pecan/blob/develop/DEBUGING.md
small typo error in file naming

• here the file name should be DEBUGGING.md instead of DEBUGING.md

[ayushman1210]

Git & GitHub Workflow documentation references outdated master branch
the Git and GitHub Workflow section of the PEcAn documentation (PEcAn Book), it still instructs contributors to use the master branch (for example, commands like git checkout master).
However, the PEcAn repository’s default branch is now main. Following the current documentation can therefore cause confusion or errors for new contributors when setting up their local development environment.