Document models

[PromiseFru]

A model is a single unit (functions) that performs a particular operation. Models are found in the /models directory in the repository. Due to the increase in features of the project more models are created and it'll be good to be able to know which model can perform a particular operation to avoid creating duplicate models

Preferred tool: https://www.npmjs.com/package/jsdoc
Preferred export format: Markdown https://github.com/jsdoc2md/jsdoc-to-markdown

[moforemmanuel]

Good morning @PromiseFru
Exporting with jsdoc2md emits just skeletal markdown, no styles, scripts, custom fonts included (suppose using a jsdoc template like docdash).
Will it be sufficient enough to fit the requirements?

Looked for alternatives, and Pandoc seemed worth a try but little complicated a process, so I thought of reaching out ...

[PromiseFru]

Good morning @PromiseFru Exporting with jsdoc2md emits just skeletal markdown, no styles, scripts, custom fonts included (suppose using a jsdoc template like docdash). Will it be sufficient enough to fit the requirements?

Looked for alternatives, and Pandoc seemed worth a try but little complicated a process, so I thought of reaching out ...

Hi @moforemmanuel, that sounds great! Please feel free to proceed with your implementation 🙂

[moforemmanuel]

Alright.
Also, should it be a standalone project (own repo) or a sub project (folder) of SWOB-BE?