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

Create a JSDoc template #1

Open

JeremiePat opened this issue Mar 26, 2020 · 0 comments

Labels

Milestone

Owner

JeremiePat commented Mar 26, 2020

JSDoc is awesome for documenting the API but available templates sucks (either ugly, broken or hard to read).

We need a template that is:

More compact
Searchable (consider Algolia API)
Easy navigation UI
Mobile friendly

JeremiePat added the documentation label

JeremiePat added this to the v1.0.0 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment