Skip to content
This repository was archived by the owner on Jul 2, 2019. It is now read-only.
This repository was archived by the owner on Jul 2, 2019. It is now read-only.

Write Documentation #8

Description

@robertcampion

One of the major tasks I want to accomplish this year is to thoroughly document the code. We can break the documentation into two categories:

  • User documentation: minimally technical instructions for setting up and using the system, sort of a user's guide.
  • Developer documentation: information about how the code works (from code organization to individual methods).

The user's guide and overview should definitely get put on the wiki; but at the most detailed level I'm not sure if we want to document in the code itself, or in the wiki. What do you think?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions