Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The purpose of adding the documentation
The Kitsu client does not currently have a documentation which makes it, as it develops, difficult to read and understand. To make sure the code is readable and easy to maintain, it's good practice to add documentation to it.
This is what was done here using JSDoc.
The reason behind the choice of JSDoc
The use of JSDoc was based on its popularity as an API documentation generator for JavaScript. It is one of the most recommended tools for its ease of use and high customization, and it shows in the resulting website.
JSDoc works in the following way: the developer adds documentation comments directly to the source code which JSDoc will scan. It will then generate an HTML documentation website.
The current state of the documentation
A detailed documentation has been added to the existing code in the project, but it is still a work in progress.