-
Notifications
You must be signed in to change notification settings - Fork 224
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
Add Jazzy Documentation #58
Comments
Are you looking to split the ReadMe into more consumable chunks, or move documentation to markup above methods and classes in the swift files? Or both? |
Here's what it looks like with a minimal amount of Jazzy config: https://right-notebook.surge.sh/ |
@xtopolis Yes that is looking good - so it would just be getting to 100% documentation coverage. |
|
@mohinee Awesome, do you need guidance, or do you just want to jump in and add to the PR? |
@xtopolis - I might need a little guidance as I have never used jazzy, do let me know what needs to be done so I can at least start |
Invited you to my fork, I'll tag you in the PR with instructions |
I'd like to help, too |
Invited you to the fork @LMVogel |
Updated the PR to make it easier to see how to get started: #176 |
As we are growing, documentation will be a lot to handle - we should use Jazzy as a way to have clean and concise documentation.
The text was updated successfully, but these errors were encountered: