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

Docs for Debugging #133

Closed
jpfairbanks opened this issue Jul 27, 2023 · 1 comment
Closed

Docs for Debugging #133

jpfairbanks opened this issue Jul 27, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jpfairbanks
Copy link
Member

The PR #128 removed some docs on how to debug a simulation. This should be restored sooner rather than later.

@jpfairbanks jpfairbanks added the documentation Improvements or additions to documentation label Jul 27, 2023
@lukem12345
Copy link
Member

lukem12345 commented Oct 8, 2023

A few docs changes are currently sitting in the backlog, like this one. I want to address them in 1 issue & PR duo to reduce overhead and start-stop delays.

Changes to make:

  • This issue
  • Add Klausmeier model docs page
  • Add CISM benchmark page
  • Update README (especially important for first impressions)
  • Spruce up the 1D Poiseuille doc
  • Update the "stable" docs link

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

No branches or pull requests

2 participants