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

Cleanup Documentation #21

Open
shetaye opened this issue May 22, 2020 · 0 comments
Open

Cleanup Documentation #21

shetaye opened this issue May 22, 2020 · 0 comments
Assignees
@shetaye
Labels
documentation Improvements or additions to documentation

Comments

@shetaye
Copy link
Owner

shetaye commented May 22, 2020

Documentation should not be split between TypeDoc and many README.MDs. What could be done is:

  • Consolidate all documentation into READMEs and remove TypeDoc annotations

or

  • Remove all the READMEs and move to untyped JSDoc annotations. If we're moving forward with annotations, it makes far more sense to use JSDoc for its much larger assortment of features rather than TypeDoc.

(From GitLab)
@shetaye shetaye added the documentation Improvements or additions to documentation label May 22, 2020
@shetaye shetaye added this to the Phase 2 milestone May 22, 2020
@shetaye shetaye self-assigned this May 22, 2020
@shetaye shetaye modified the milestones: Phase 2, Phase 3 Jun 11, 2020
@shetaye shetaye added addition Adds (or helps add) value to Swish and removed addition Adds (or helps add) value to Swish labels Jun 15, 2020
@shetaye shetaye removed this from the Phase 3 milestone Jun 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@shetaye shetaye

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@shetaye