alu/cse110-fa22-group29
1
0
Fork 0
mirror of https://github.com/cse110-fa22-group29/cse110-fa22-group29.git synced 2024-11-10 05:34:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
aa7e13b205
cse110-fa22-group29/specs/adrs/112922-documentation-jsdoc.md
Arthur Lu 793e7891b3 prettier style fixes 
Signed-off-by: Arthur Lu <learthurgo@gmail.com>
2022-12-03 02:02:52 +00:00

444 B
Raw Blame History

Use JSDoc for JS documentation

  • Status: accept
  • Deciders: Arthur Lu, Marc Reta
  • Date: 11 / 29 / 22

Decision Drivers

  • Need simple way to publish documentation for code
  • Already documentating infile using JSDoc style

Considered Options

  • JSDoc

Decision Outcome

Chosen Option: JSDoc. Will run by generating docs in /source/docs/ before publishing /source/ so users can enter the URI /docs/ to see documentation.