Closed dsebastien closed 6 years ago
Old internal docs/pointers:
Goal: describe how to document code for our applications (ES/TS).
Depending on the basic stack we've chosen, we should be able to identify tools to document our code (e.g., JSDoc or TypeDoc?).
Also, we should see if there's a mean to link this with code quality checks (i.e., is enough code documented or not).
We also need support in the IDE for the chosen solution!
References to check:
Goal: finalize discussions around code documentation and produce documentation for the developer guide.
To cover:
Documentation page to complete: https://confluence.prd.nbb/display/jag/Front-end+code+documentation
DGeni:
JSDoc:
Compodoc:
Compodoc selected as it has very nice Angular support (modules, injectables, routes, ...)
Docs will be generated under reports/api-docs/<package name>
Properly integrate documentation generation in Stark and in the starter