Document API

[trodi]

Options to possible auto generate API docs:

• Typedoc
• Markdown for Typedoc

Game Plan

• Generate API docs via Typedoc Markdown plugin
  • Ideally, I'd create a custom Typedoc template that is simpler for this type of API, but I'll punt on that for now.
• Should I commit generated API docs?
  • I don't like committing generated files; they are artifacts of the build.
  • Any issues with npm publish?

[trodi]

I ended up committing the generated docs because I couldn't get npm to link correctly.

Future considerations:

• Do older versions link to the correct API doc version?
• Can I avoid committing these generated docs considering I published them?