[Feature] Extend and write project documentation - Githubissues

DeadlyFirex / PrimoTracker

Suite of tools to track your income over time of primo's.

GNU Affero General Public License v3.0

1 stars 0 forks source link

[Feature] Extend and write project documentation #19

Open DeadlyFirex opened 9 months ago

DeadlyFirex commented 9 months ago

Description Currently, the project has little or no documentation and it requires proper documentation. This issue aims to address this issues.

Context No detailed configuration currently exists, nor are any endpoints properly documented.

No clear / consistent docstrings under functions.
No documentation for blueprints, functions or configuration.
No wiki on GitHub.

Expected Behavior

Create a centralized documentation page.
Document endpoints and their blueprints.
Make consistent use of docstrings.

Use Case Examples

Administrators / developers can debug and troubleshoot issues.
Administrators can read on the configuration's options.
Developers are able to understand the services' functions.

Requirements

[ ] Research options for documentation frameworks, or design one.
[ ] Update README.md.
[ ] Create a wiki page.
[ ] Comment / docstring endpoints and functions.
[ ] Document configuration settings and their options.
[ ] Design guides for basic service operation.
[ ] Validate and review configuration documentation.
[ ] Integration into deployment.

Considerations N/A

Additional Information N/A

Dependencies

Depends-on: #11
Depends-on: #8

Related N/A