You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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:
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.The text was updated successfully, but these errors were encountered: