Help page - Githubissues

hajicj / rhythmify_frontend

0 stars 1 forks source link

Help page #7

Open hajicj opened 2 years ago

hajicj commented 2 years ago

The server must provide some clearer documentation.

[ ] The bachelor thesis on which it is based should be a part of the repository and linked to the website
[ ] The user guide should be directly available through a link
[ ] A more detailed explanation of the alignment settings should be given
[ ] The user guide should be re-worked in a way that allows for simpler updating

hajicj commented 2 years ago

For reference documentation:

The TSDoc system exists for typescript docstrings. API Extractor then generates a JSON file, which is turned in to a human-readable page by another tool.