Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation using jsdoc #2

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Add documentation using jsdoc #2

wants to merge 2 commits into from

Conversation

NehmatH
Copy link

@NehmatH NehmatH commented Aug 25, 2022

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.

@NehmatH NehmatH marked this pull request as ready for review August 26, 2022 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant