search

intuit / CardParts

A reactive, card-based UI framework built on UIKit for iOS developers.
Other
2.52k stars 225 forks source link

Add Jazzy Documentation #58

Open croossin opened 6 years ago

croossin commented 6 years ago

As we are growing, documentation will be a lot to handle - we should use Jazzy as a way to have clean and concise documentation.

xtopolis commented 4 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?

xtopolis commented 4 years ago

Here's what it looks like with a minimal amount of Jazzy config: https://right-notebook.surge.sh/

croossin commented 4 years ago

@xtopolis Yes that is looking good - so it would just be getting to 100% documentation coverage.

xtopolis commented 4 years ago

~# Note any Hacktoberfest'ers - if you want to help me on this PR, feel free! #176~

mohinee commented 4 years ago

@croossin , @xtopolis I am interested in helping you out with this

xtopolis commented 4 years ago

@mohinee Awesome, do you need guidance, or do you just want to jump in and add to the PR?

mohinee commented 4 years ago

@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

xtopolis commented 4 years ago

Invited you to my fork, I'll tag you in the PR with instructions

LMVogel commented 4 years ago

I'd like to help, too

xtopolis commented 4 years ago

Invited you to the fork @LMVogel

xtopolis commented 4 years ago

Updated the PR to make it easier to see how to get started: https://github.com/intuit/CardParts/pull/176