Skip to content

Documentation #6

Open
Open

Description

@anseljh

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:

Activity

  1. anseljh commented on Oct 5, 2015

    @anseljh
    MemberAuthor

    @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.

  2. kemitchell commented on Oct 6, 2015

    @kemitchell
    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions