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

Automatic doc generation for the Matterwiki API #128

Open
krishnagopinath opened this issue Dec 23, 2017 · 0 comments
Open

Automatic doc generation for the Matterwiki API #128

krishnagopinath opened this issue Dec 23, 2017 · 0 comments

Comments

@krishnagopinath
Copy link
Collaborator

krishnagopinath commented Dec 23, 2017

The API is slowly starting to grow to a "mid sized" application by itself and it might be time to start documenting it, so we can keep track of the changes to it.

The idea is simple:

  • Someone adds an endpoint to an API and a JSDoc for the API (via PR)
  • We could use apiDoc to convert JSDoc comments to html.
  • We could stop here, but since we want this to be in our repo in MD, use apidoc-markdown to convert static html to MD.

We should probably automate these steps, maybe add a CI task that looks for changes in the src/api/* files and regenerates these whenever a PR is made.

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