Skip to content
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

Open
croossin opened this issue Jun 25, 2018 · 11 comments
Open

Add Jazzy Documentation #58

croossin opened this issue Jun 25, 2018 · 11 comments
Assignees
Labels
enhancement New feature or request hacktoberfest A label dedicated to issues that would be participating in Hacktoberferst

Comments

@croossin
Copy link
Contributor

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

@croossin croossin added the enhancement New feature or request label Jun 25, 2018
@croossin croossin added the hacktoberfest A label dedicated to issues that would be participating in Hacktoberferst label Sep 23, 2019
@xtopolis
Copy link

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
Copy link

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

@xtopolis xtopolis mentioned this issue Sep 25, 2019
1 task
@croossin
Copy link
Contributor Author

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

@xtopolis
Copy link

xtopolis commented Oct 2, 2019

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

@mohinee
Copy link

mohinee commented Oct 3, 2019

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

@xtopolis
Copy link

xtopolis commented Oct 3, 2019

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

@mohinee
Copy link

mohinee commented Oct 3, 2019

@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
Copy link

xtopolis commented Oct 4, 2019

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

@LMVogel
Copy link

LMVogel commented Oct 7, 2019

I'd like to help, too

@xtopolis
Copy link

xtopolis commented Oct 7, 2019

Invited you to the fork @LMVogel

@xtopolis
Copy link

Updated the PR to make it easier to see how to get started: #176

@xtopolis xtopolis mentioned this issue Oct 21, 2019
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request hacktoberfest A label dedicated to issues that would be participating in Hacktoberferst
Projects
None yet
Development

No branches or pull requests

5 participants