Investigate 'Javascript heap out of memory' error

[chasulin]

An error saying "Javascript heap out of memory" popped up in the WorldMap component PR, and blocked the pr from building successfully (and deploying to firebase). The source of the error seems to be the generation of typedocs, and a quick fix was just to disable typedocs (remove yarn generate-docs from the build script) for now, so as to not block merging the WorldMap.

Things we've tried so far:

• Doubling the amount of allotted memory
• Upgrading typedocs

[mikelehen]

It looks like this is a known typedoc issue: TypeStrong/typedoc#1606. They are working on it, with the last progress update 9 days ago.

[mikelehen]

I've found that if we generate docs directly from the package sources (yarn typedoc packages/*/src/index.ts) instead of using the "monorepo support" (yarn typedoc --entryPointStrategy packages . then it's a lot faster and uses less memory. The downside is the overall structure of the docs make it look like a single package with assert/src, metrics/src, etc. instead of separate modules (@actnowcoalition/assert, @actnowcoalition/metrics, etc.). This isn't ideal for our public facing docs, but I think is probably fine for right now.

One side benefit of this change is that it makes cross-linking classes across packages work, which is currently another Typedoc bug with monorepo support (TypeStrong/typedoc#1835).

When TypeStrong/typedoc#1606 is addressed, we can revisit this.