App Utilities

[NilsG-S]

To Do:

• Extract out component utility functions
  • navigate - add location checking
• Change password rules
• Add esdoc

[asclines]

Before we get to involved with ESDoc, @NilsG-S have you had the chance to look in documentation generators. Since using ESDoc, I have found others such as documentationjs that may also serve our needs.

[NilsG-S]

@asclines I haven't had the chance to look at other documentation generators, but I have no problem with switching. I have a couple of questions though. First, how time consuming would it be to switch at this point? Second, what criteria are we looking for that would indicate a documentation generator that we can stick with?

[asclines]

For you, not time-consuming at all 😛 For me, eh not that big of a deal. At least not between these two generators. Their syntax stem from the same source (JSDOC).

As for criteria:

• ES6 compatible
• React compatible
• Easy to navigate output
• Easy to read output in addition to easy to read inline the source code

At least, these are my main criteria.

[NilsG-S]

Those sound good. Would documentationjs fulfill those requirements, or should we do more searching? Should we do more searching regardless?

[asclines]

I think it is worth doing more research into. Since I've started using ESDoc, I've begun noticing a few issues with it that I think could be addressed with another documentation generator. For example, the organization provided by ESDoc is very unintuitive and gets cluttered easily.

[NilsG-S]

Alright, I'll put in some time researching where I can, but my main focus will be content for the front end.