Skip to content

Write Documentation #9

@ElphaTech

Description

@ElphaTech

Is your feature request related to a problem? Please describe.
There is currently minimal documentation which makes both using the software and contributing to it difficult.

Describe the solution you'd like
Write documentation in docs/ on the following:

  • Installation and setup.
  • General use.
  • All config options.
  • data.json parameters (Added docs for data.json #21 )
  • Job parameters (in daemon)
  • Flag docs file with all availible flags and what they do.

Additional context
This could in future be added as a tab in the TUI as well as having the setup info show as the first page on first being run.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions