[📚] The rnfirebase.io documentation site is not generating reference API docs for all modules

[mikehardy]

The rnfirebase.io documentation site is not generating reference API docs for all modules

Specifically, analytics at minimum is missing, it appears quite a few other modules are as well

@sichan75 thanks for pointing this out!

Originally posted by @mikehardy in #8268

[mikehardy]

There is one main thing going on, then a few derivative things that will affect a possible solution

The main thing going on is that none of the typescript-native modules are being correctly documented - typedoc with its current config does not "see" those modules, and I was unable to educate it properly with configuration so it would see it.

Part of the problem is we are on typedoc v0.19, whereas current stable is 0.28. Additionally, support for monorepos was added in later versions - which would help a lot.

I believe the first step is to create a general configuration starting from scratch for all the modules with current stable typedoc, using the monorepo support

Hopefully it works with the existing rnfirebase.io gatsby site, at which point this may be closed.

If not, then I think the proper next step is to simply generate a more-or-less stock typedoc site and reconfigure the existing gatsby site to simply generate it and refer to it, vs the currently styled one. Why would that be acceptable? Because that is the likely solution in the future for a docs.page-backed rnfirebase.io redo any way

[alex-mironov]

any guess on when this can be fixed? thank you

[mikehardy]

There cannot be deadlines in open source, the incentives don't line up that way
It's a high priority but it still competes with other high priorities and the scope was unfortunately larger than I'd anticipated

For the modules that are missing, the fundamental reason they are missing is because they are native typescript now, which implies that you can look directly at the related source files (which we do ship with the modules) and the APIs are right there - typically documented and now fully typed. That is, there's "API reference docs" in the IDE now, not just a website.

Additionally, if you open the file on github, the github web UI will make the methods clickable and such which isn't that different an experience than the reference section of the rnfirebase.io website is

Offering those workarounds doesn't mean I/we don't want to get the reference docs back up, but they are meant to underscore that this shouldn't be blocking any developer with a browser or an IDE that does intellisense from typescript files...