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

Documentation #6

Open
anseljh opened this issue Oct 4, 2015 · 2 comments
Open

Documentation #6

anseljh opened this issue Oct 4, 2015 · 2 comments

Comments

@anseljh
Copy link
Member

anseljh commented Oct 4, 2015

We should write up some real documentation. I'm happy to help!

I see at least these areas:

  1. Markup
  2. How to use the web app
  3. How to use the CLI
  4. How to contribute to development

Some good points for us to keep in mind:

@anseljh
Copy link
Member Author

anseljh commented Oct 5, 2015

@kemitchell what are your feelings about API docs (i.e., generated with ESDoc, JSDoc, etc.)? I'm on the fence about whether they would be worth the effort.

@kemitchell
Copy link
Member

Until someone needs API docs in particular, I prefer to keep things as lean as possible.

I should probably comment more. But I think I've done alright keeping packages small. The tests-in-README thing is a bit eccentric, but I find it does the job most of the time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants