Open croossin opened 6 years ago
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.
~# Note any Hacktoberfest'ers - if you want to help me on this PR, feel free! #176~
@croossin , @xtopolis I am interested in helping you out with this
@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: https://github.com/intuit/CardParts/pull/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.