draftjs-conductor icon indicating copy to clipboard operation
draftjs-conductor copied to clipboard

Published 20 hours ago • verified publisher icon thibaudcolas

Add automated documentation generation

Open thibaudcolas opened this issue 6 years ago • 1 comments

At the moment, the project's documentation is limited to what is in the README. It would be nice if there was more complete documentation generated automatically: a full API reference, with links back to the source code, based on the Flow types (or JSDoc).

Ideally this would be generating Markdown so it can be versioned with the code in Git/GitHub.

Tools to consider & useful info:

  • https://github.com/documentationjs/documentation
  • https://github.com/esdoc/esdoc
  • https://survivejs.com/maintenance/documentation/readme/
  • https://survivejs.com/maintenance/documentation/api/

thibaudcolas avatar Sep 30 '18 21:09 thibaudcolas

See https://github.com/thibaudcolas/draftjs-filters/issues/19, https://github.com/thibaudcolas/draftjs-filters/pull/26 for a solution.

thibaudcolas avatar Jan 24 '19 13:01 thibaudcolas