[Feature] Add textual explanations to entities.

[JustSamuel]

What would you like?

To be able to browse a clear and well-structured documentation of SudoSOS. Since we do not have wiki, nor does our swagger explain the inner workings.

Why is this needed?

Clearly.

How could it be implemented?

I suggest using TypeDoc in combination with typedoc-plugin-merge-modules to be able to nicely structure our documentation. TypeDoc allows for blocks of text to be added in module files, which makes it great for writing how a certain entity should be used.

Other information

No response

Update

Since the TypeDoc PR is now live (#333) I think we move this from feature to enhancement, as the current goal is now to improve documentation projectwide. See #336

TODO Entity Docs:

• src/database/migrate.ts
• src/entity/banner.ts
• src/entity/vat-group.ts
• src/entity/container/container.ts
• src/entity/event/event.ts
• src/entity/fine/userFineGroup.ts
• src/entity/invoices/invoice.ts
• src/entity/point-of-sale/point-of-sale.ts
• src/entity/product/product-category.ts
• src/entity/product/product.ts
• src/entity/rbac/role.ts
• src/entity/report/report.ts
• src/entity/stripe/stripe-deposit.ts
• src/entity/transactions/transaction.ts
• src/entity/transactions/transfer.ts
• src/entity/transactions/write-off.ts
• src/entity/transactions/payout/payout-request.ts
• src/entity/transactions/payout/seller-payout.ts
• src/entity/user/user.ts
• src/entity/user/voucher-group.ts
• src/gewis/gewis.ts
• src/mailer/index.ts