-
Notifications
You must be signed in to change notification settings - Fork 6
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
Doku intro #138
Doku intro #138
Conversation
as a side effect: the api references are updated |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for updating so much of the docu! That's a big step forward. I made small edits here and there. Feel free to accept the suggestions as you see fits.
The API docs part seems auto-generated. However, I was surprised to see it in this PR. Should we try to rather integrate it into the CI somehow for the future? I don't know how that exactly works, but I'll open an issue for it :)
Ah, I forgot to say that I rendered the docu locally and checked the changes meaning that all images are still displayed and all chapters are reachable and so on. All good from that side :) |
One more thought on this PR, you could think of merging all documents under |
Co-authored-by: Theresa Mieslinger <41184617+tmieslinger@users.noreply.github.com>
Co-authored-by: Theresa Mieslinger <41184617+tmieslinger@users.noreply.github.com>
Thanks for reading everything. I would keep the tutorial separate. I hate long explanation pages (also, I think an 'Installation' link helps to find it faster). but maybe that's just personal. It would be cool to build the api references automatically. Maybe we can figure that out :) |
rearranged doku website