Skip to content

Add documentation #149

@trpyn

Description

@trpyn

We currently have no documentation except for the tryhackme room and the Readme.

We would need at least:

  • Installation / Setup for multiples deployment types (docker and bare metal)
  • Quick Start: simple example and tutorials on how to get started
  • Cookbooks: how to perform common tasks
  • Detailed description of tabs, features, and every information displayed
  • Troubleshooting section with common issues
  • Internal workings: have some necessary information about Pithus' inner working so that anyone can understand how it functions

A website dedicated to the documentation would be ideal.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions