-
Notifications
You must be signed in to change notification settings - Fork 15
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
Initial implementation of documentation #52
Conversation
Codecov Report
@@ Coverage Diff @@
## master #52 +/- ##
=======================================
Coverage 92.84% 92.84%
=======================================
Files 19 19
Lines 461 461
=======================================
Hits 428 428
Misses 33 33 Continue to review full report at Codecov.
|
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.
Can we have a preview of the docs in the PR? I remember it is possible to configure Documenter.jl and the repo to show a preview. Someone asked this recently on Zulip as well. Can you double check?
I updated the examples of the |
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.
Awesome work. 💯
Thanks |
I was inspired by the Meshes.jl reference guide to make this reference guide. I think the sections could have better separation and better names.I'm waiting for your suggestions @juliohm.
Edit:
I put the README text in index.md and added the Transforms docstrings in transforms.md.