Open LeonMontealegre opened 3 years ago
Another potential type of documentation to consider adding: some kind of "exit docs" that someone could fill out if they are in the middle of working on something, but the semester is about to end and they don't plan on continuing working on OpenCircuits after that. They could explain what branch the work is on, what work has been done, and what work is still left to do.
I noticed while creating jsdocs in #630 that the throws and see tags do not show up in the auto-generated jsdocs. Not sure if that was an intentional omission, I messed something up/didn't see it, or it wasn't yet implemented, but I think those should also should show up in the generated documentation.
Note for myself:
Could be cool to have any documentation-changing PRs get published onto a sub-url of the docs site like: docs.opencircuits.io/pull/###
so that it can be viewed without having to manually checkout and run the docs server
Proper documentation is desperately needed, I am currently working on it but it should be officially documented (pun intended) as well.
Tasks:
From PR #684 :
Known issues:
Planned features:
Need to test:
(extra todo: UML diagrams, (see Demopans discord chat leon))