Reasearch how to generate techincal documentation based on code/comments

[EmilPasca]

See if there is a tool/library that can help you generate documentation based on the project code/comments, similar to how Javadoc is generated for java based projects.

If you need a refresher on Javadoc, you can find more here: https://www.geeksforgeeks.org/what-is-javadoc-tool-and-how-to-use-it/

[dariabuciuman]

In order to generate technical documentation we will use the Compodoc tool. To install it, you need to run the npm install --save-dev @compodoc/compodoc command in the parent folder of the project. After the installation is complete, just run the npm run compodoc command and access http://127.0.0.1:8080 in a browser of your choice, where you can find the generated documentation.

Let me know if there is anything else to be done or if I can close the issue. Thank you and happy holidays! :)

[EmilPasca]

Good work! Thanks for providing this info. I had managed to successfully verify the documentation.

One enhancement that I would suggest trying is increasing the documentation coverage (This is entirely up to you, the fact that you had managed to implement this is enough for the current task).

Feel free to close this issue.

[mszab0310]

We will add some comments on the main functionalities of the application, because as far as I know it generates what you shared on the screenshot based on code comments, and we didn't really comment anything, so it would be a good idea to fix it up, so the documentation will be more precise. It would help with maintaining the project on the long term as well!