Create project documentation

[mit3r]

Create documentation

We should create documentation for our project. Some mechanisms are quite complicated and difficult to understand just by looking at a code snippet, and a simple description in such documentation will allow us to properly direct our project.

Requirements

Documentation should convey the general principle of how the code works. It will be a single Markdown file (.md), in which individual sections will explain mechanisms, e.g. choosing a seat, what happens in the lobby

[Aleks334]

Maybe we could also use JSDoc (with better-docs) in project and auto-generate api docs? An .md file might still be useful to provide more details. It can be done also later if it isn't needed now.

Example of docs made with jsDoc & better-docs: https://softwarebrothers.github.io/example-design-system/index.html

https://jsdoc.app/
https://github.com/SoftwareBrothers/better-docs

[mit3r]

It looks very nice. For now we can collect documentation in this one file, but in the future if it will be more handy we will think about these solutions