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.

Sign up for GitHub

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

Jump to bottom

Documentation Site #14

Open
jhasuraj01 opened this issue May 1, 2022 · 0 comments
Open

Documentation Site #14

jhasuraj01 opened this issue May 1, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@jhasuraj01
Copy link
Member

In order to maximize the use of this package it is really important to create best documentation covering

  1. Examples Code for each Data Structure
  2. Detailed Explanation for each method of every class
  3. Use Cases and Sample Implementation in Real Projects

Currently the documentation website is generated using TypeDoc. We are looking for a better alternative or improvement in current implementation to automate the documentation process as much as possible and make it best for readers to understand and use this package.
@jhasuraj01 jhasuraj01 added documentation Improvements or additions to documentation help wanted Extra attention is needed labels May 1, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@jhasuraj01