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: Improve docs #111

Merged
merged 15 commits into from
Sep 23, 2024
Merged

docs: Improve docs #111

merged 15 commits into from
Sep 23, 2024

Conversation

ewuerger
Copy link
Member

@ewuerger ewuerger commented Sep 20, 2024

Rebuild the whole documentation.

Depends on PR #93.

@ewuerger ewuerger added the documentation Improvements or additions to documentation label Sep 20, 2024
@ewuerger ewuerger requested a review from vik378 September 20, 2024 09:28
@ewuerger ewuerger self-assigned this Sep 20, 2024
@vik378
Copy link
Member

vik378 commented Sep 23, 2024

All-in-all better than nothing, but we should improve it later as there are way too many assumptions re prior knowledge / reader's initial understanding, lets see if we can improve this a bit before the event with a tiny readme update.

@ewuerger ewuerger merged commit ba8a5b1 into main Sep 23, 2024
7 checks passed
@ewuerger ewuerger deleted the improve-docs branch September 23, 2024 10:09
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 this pull request may close these issues.

3 participants