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.

Sign up for GitHub

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

Jump to bottom

Cookbook is outdated #886

Open

sebwolf-de opened this issue Jun 15, 2023 · 0 comments

Labels

bug

Contributor

sebwolf-de commented Jun 15, 2023

Describe the bug
The cookbook is outdated. It contains a lot of steps that are not needed any more.

Expected behavior
The cookbook in the documentation should reflect the most recent workflows. It should mostly point to SeisSol/Examples.

To Reproduce
Steps to reproduce the behavior:
Read https://seissol.readthedocs.io/en/latest/tpv5.html, https://seissol.readthedocs.io/en/latest/a-first-example.html

Additional context
I see two options:

Update the documentation now.
Remove most of the documentation and add a lot of README.md in SeisSol/Examples.
I favor option 2. If we change the workflows once again (not planned yet, but will happen for sure), we will most likely update SeisSol/Examples, but forget the documentation in this repository.

sebwolf-de added the bug label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment