Skip to content

Documentation improvements. #20

@InfoX1337

Description

@InfoX1337

Rewrite the README including the following sections:

  • Project Overview
  • Features
  • Project Structure
  • Getting Started
  • Running the project
  • Environment variables
  • Building for prod (howto)
  • Testing (how to run unit tests that, as of right now, dont exist)
  • Contributing how to
  • License
  • Contact / Maintainer info

Additional documentation files to accompany README

  • DEPLOYMENT.md – Detailed deployment instructions (environment setup, CI/CD, hosting).
  • CONTRIBUTING.md** – Guidelines for contributors (branch naming, commit style, code review).
  • And any others that may be warranted.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions