Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #205

Open
wants to merge 126 commits into
base: main
Choose a base branch
from
Open

Update documentation #205

wants to merge 126 commits into from

Conversation

GlennStrypsteen
Copy link
Collaborator

update vegetation documentation

@Sierd
Copy link
Collaborator

Sierd commented Aug 11, 2024

The flyout menu on readthedocs is back but in another format. This seems to be a sphinx update. I manually switched some addon button to activate it.

We can switch between docs versions again.

Strypsteen 2024 was defined twice. This made the references crash. I included an alternative label. The references work again!
@Sierd
Copy link
Collaborator

Sierd commented Aug 16, 2024

@GlennStrypsteen, if fixed the bib issue (some of your own publications were defined with using the same name label). Please check if references are still correct. I think one of the references to one of your papers should be adapted as well.

@GlennStrypsteen
Copy link
Collaborator Author

@GlennStrypsteen, if fixed the bib issue (some of your own publications were defined with using the same name label). Please check if references are still correct. I think one of the references to one of your papers should be adapted as well.

Thanks Sierd, I will check and finalize the vegetation documentation.

@christavanijzendoorn
Copy link
Collaborator

Hi everyone, I've restructured the model description section and made sure there are no errors anymore in the read the docs build. I've also added some references to the discussion board in the readme and docs. There are several sections in the documentation that still need to be filled in. Please find your assigned tasks below.

  • @Sierd: Model setup > Guidance on solver use & Model description > Numerical implementation of the advection equation. The last one needs to be cleaned up, added to, restructured? Feel free to change whatever is needed.
  • @CarolineHalllin Introduction > Model overview & Applicability and limitations, have Sierd review
  • @ncohn Model description > Sand fences and Marine erosion.
  • @bartvanwesten Model description > Morphological change > Avalanching & wet bed reset
  • @GlennStrypsteen Model description > Vegetation, I added subheaders and solved issues with references/math. From what I can see only inundation is not yet explained.
    Based on comments by Jan-Markus and Maddy I think it would also be valuable to add more conceptual figures. So please add visuals if you run into a section that could really use that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants