-
Notifications
You must be signed in to change notification settings - Fork 47
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: new documentation with mkdocs #527
Conversation
Codecov ReportBase: 89.86% // Head: 89.65% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## main #527 +/- ##
==========================================
- Coverage 89.86% 89.65% -0.22%
==========================================
Files 39 37 -2
Lines 4442 4417 -25
==========================================
- Hits 3992 3960 -32
- Misses 450 457 +7
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
It's amazing how good docs really make things crystallise in your mind - genuinely so psyched on guiclass and can't wait to use it :) |
All the new documentation is SOOO much better! (wish it was here 2 months ago haha!) Thank you so so much for all the work put into this! The logic, the flow, the extent of detail. Even after all I've learned this year with magicgui, this documentation is so much easier to navigate, clears up some sticking points I had, and more. I won't be missing the old docs. Cheers! |
Made my day, thanks for stopping by to leave a note |
I've very much enjoyed/preferred my experiences working with mkdocs, mkdocstrings, and the mkdocs-material theme. This PR converts the docs here to use mkdocs... it also dramatically reorganizes things to make usage patterns clearer;
edit ... really, this is a complete rewrite of pretty much every page 😂