-
Notifications
You must be signed in to change notification settings - Fork 2
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
Improved documentation #10
Conversation
b3cc17c
to
c1e665c
Compare
c1e665c
to
c0d0ab1
Compare
1890597
to
15615c2
Compare
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #10 +/- ##
==========================================
- Coverage 99.46% 99.46% -0.01%
==========================================
Files 25 25
Lines 1116 1112 -4
==========================================
- Hits 1110 1106 -4
Misses 6 6
|
I've just realized I cannot see the image at the top of "description.md" when serving the documentation in local. There may be an issue with the path. |
Well I checked the path and it is ok. I think the figure will appear as we merge the PR |
Proposed changes
I improved the documentation by fixing a broken link, splitting a webpage in two extended ones, expanding some descriptions and adding an illustration