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

Documentation #12

Open
agarzola opened this issue Jun 16, 2018 · 0 comments
Open

Documentation #12

agarzola opened this issue Jun 16, 2018 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@agarzola
Copy link
Member

We need to document how to use jsonmonger. I have a WIP branch called documentation (highly volatile, I’m rewriting its history often) which aims to document every method and the library’s usage, along with several use cases.

That branch uses jsdoc, but I’m open to alternatives. As much as possible, I’d like to keep the documentation of specific methods and features right in line with the code.

@agarzola agarzola added help wanted Extra attention is needed good first issue Good for newcomers labels Jun 16, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant