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

docs: automated generation #253

Open
AVVS opened this issue Oct 8, 2017 · 0 comments
Open

docs: automated generation #253

AVVS opened this issue Oct 8, 2017 · 0 comments
Milestone

Comments

@AVVS
Copy link
Member

AVVS commented Oct 8, 2017

As we've already introduced flow, it's not that useful in its' current form.
Uber has a nice example of using global variables and importing definitions from node_modules.
Refactor codebase into something similar

Incorporate automatic documentation generator that can take into account existing notations, descriptions & examples.

Example of good documentation - https://googlecloudplatform.github.io/google-cloud-node/#/

@AVVS AVVS added this to the v10.0.0 milestone Oct 8, 2017
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

No branches or pull requests

1 participant