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

Improve documentation #627

Open
efaulhaber opened this issue Oct 17, 2024 · 0 comments
Open

Improve documentation #627

efaulhaber opened this issue Oct 17, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@efaulhaber
Copy link
Member

efaulhaber commented Oct 17, 2024

This issue is to collect feedback that I got from students regarding the documentation.
I will continue this issue in the future with more feedback from more students/users.

  1. using Pkg; Pkg.add("OrdinaryDiffEq", "Plots") doesn't work.
  2. Add images of shapes to the docs (rectangle, sphere, etc.).
  3. Add docs on how to visualize initial conditions for easier simulation setups.
  4. Continue the method theory page and make it easier for users to find out which methods and corrections, density diffusion, boundary conditions are best for which use case.
  5. Add more "developing TrixiParticles" information like best practices and conventions (format, comments, etc.).
  6. Make clear that API reference is inside the components docs.
@efaulhaber efaulhaber added the documentation Improvements or additions to documentation label Oct 17, 2024
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

1 participant