Skip to content

docs: automated generation #253

Description

@AVVS

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/#/

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions