Generate documentation for snippets
Background
We want an easy we generate user (filter authors) documentation for snippets. Issue #20 (closed) takes care of JSdoc, but we need output. Since the documentation should be hosted with the rest of filter documentation, the output must be usable with the CMS.
What to change
Here is what needs to be changed
-
Make a markdown template for the generatation of the how to write snippets documentation -
Write scripts to generate the output using jsodc-to-markdown
and add them to the npm scripts. -
Ensure the developer documentation is also ok. (issue #88 (closed)) -
Get the copy reviewed by tech writing.
Hints for testers
- This is the developer documentation, it doesn't impact the WebExtension.
- It currently add a tutorial on how to write snippets to that developer documentation.
Edited by Hubert Figuière