Skip to content

Define documentation.md practice #23

@jdhoffa

Description

@jdhoffa
          Possibly a topic for a separate discussion, but documentation should include
  • Purpose of repo
  • Overall structure (of repo)
  • How to use (main use case, additional usecases)
    • Invoking workflow (if applicable)
    • functions of interest
  • How to contribute (development usecase)

Originally posted by @AlexAxthelm in #12 (comment)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions