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 our documentation #772

Closed
5 tasks
Marius1311 opened this issue Dec 30, 2024 · 2 comments · Fixed by #774
Closed
5 tasks

Improve our documentation #772

Marius1311 opened this issue Dec 30, 2024 · 2 comments · Fixed by #774
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Marius1311
Copy link
Collaborator

Marius1311 commented Dec 30, 2024

We can improve our documentation in a few places to make it easier to get started. Here are some ideas:

@Marius1311 Marius1311 added the documentation Improvements or additions to documentation label Dec 30, 2024
@MUCDK
Copy link
Collaborator

MUCDK commented Dec 30, 2024

Thanks @Marius1311 !

Regarding

  1. would you suggest high-level description wrt OT or rather which tasks can be performed?
  2. what are key applications? each of the bio problems? or a subset thereof?
  3. would you then replace the boxes? Or have it in addition? Or have it integrated into the current structure?
  4. I think that makes sense, maybe @LeonStadelmann you can start doing this? I.e. for every module we would like to be able to collapse the corresponding submodules. Atm, everything is displayed.
  5. makes sense, would you use Fig. 1 or something else?

@Marius1311
Copy link
Collaborator Author

HI @MUCDK, please see #774 where I made a few suggestions!

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

Successfully merging a pull request may close this issue.

2 participants