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: reorganize documentation #171

Merged
merged 8 commits into from
Jul 21, 2024
Merged

docs: reorganize documentation #171

merged 8 commits into from
Jul 21, 2024

Conversation

nicrie
Copy link
Contributor

@nicrie nicrie commented Jul 18, 2024

Updating the package documentation:

  • Change layout of the landing page (see here)
  • Restructure the individual pages: mainly creating a User Guide with individual subpages for each topic. Also, move the example gallery into the User Guide (not sure about this; seems a bit lost there)
  • Rewrite some parts of the docs where I felt they could be clearer

@nicrie nicrie marked this pull request as ready for review July 19, 2024 08:40
@nicrie nicrie requested a review from slevang July 19, 2024 08:40
Copy link

codecov bot commented Jul 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Please upload report for BASE (main@909cb7e). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #171   +/-   ##
=======================================
  Coverage        ?   25.49%           
=======================================
  Files           ?       43           
  Lines           ?     3251           
  Branches        ?        0           
=======================================
  Hits            ?      829           
  Misses          ?     2422           
  Partials        ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@nicrie nicrie marked this pull request as draft July 19, 2024 10:55
@nicrie nicrie marked this pull request as ready for review July 19, 2024 11:26
Copy link
Contributor

@slevang slevang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

Also, move the example gallery into the User Guide (not sure about this; seems a bit lost there)

Seems like the right place, I think it fits here.

@nicrie nicrie merged commit aa28770 into main Jul 21, 2024
6 checks passed
@nicrie nicrie deleted the update-documentation branch August 25, 2024 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants