docs: publish a close-to-stock typedoc reference site to GitHub Pages, manually or on publish

[mikehardy]

Description

Our reference API site is currently built using a customized typedoc JSON output converter written in Gatsby - it is all out of date and doesn't work well with our new typescript-converted modules.

This PR implements a typedoc config that is very close to stock typedoc recommendations for monorepos with no plugins and raw HTML output

It then implements a publish of that output to github pages as a new step in the publish.yml workflow so that our reference API is updated to match the current release on main as the release goes out.

A future PR will modify the existing docs generator in website/ so that it no longer generates a reference API site internally, and all reference API links are rewritten to link to the new github pages site for reference API docs - need to merge this and publish first so that I can run a link checker on the non-reference site during re-mapping to make sure all reference links resolve in their new home

Related issues

• Obsoletes docs: use docs.page to host docs, with typedoc to generate reference API #8886
• Fixes [📚] The rnfirebase.io documentation site is not generating reference API docs for all modules #8858
• Related (because the typescript conversion broke the existing reference API generator) ☂️ React Native Firebase refactor #8584

Release Summary

• fix release so it will publish, and will generate the reference API and publish it

Checklist

• I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • Yes
• My change supports the following platforms;
  • Android
  • iOS
  • Other (macOS, web)
• My change includes tests;
  • e2e tests added or updated in packages/\*\*/e2e
  • jest tests added or updated in packages/\*\*/__tests__
• I have updated TypeScript types that are affected by my change.
• This is a breaking change;
  • Yes
  • No

Test Plan

1- Check out this branch / PR
2- run yarn && yarn reference:api
3- using a browser, open reference/index.html

1- After merge, attempt a manual / workflow-dispatch run of just the reference API publish workflow
2- and a publish of the whole repo which should also publish the reference API via a workflow call at end of publish workflow

---

Think react-native-firebase is great? Please consider supporting the project with any of the below:

• 👉 Star this repo on GitHub ⭐️
• 👉 Follow React Native Firebase and Invertase on Twitter

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
react-native-firebase	Error		Apr 7, 2026 0:39am

[gemini-code-assist]

Code Review

This pull request introduces TypeDoc for automated API documentation generation across the monorepo, adding a central configuration, individual package settings, and new npm scripts. The review feedback identifies that the vertexai package was omitted from the main entry points despite having a configuration file, suggests enabling invalidLink validation to improve documentation quality, and recommends adding missing configuration files for several other packages to ensure they are documented correctly.

[cursor]

You have used all of your free Bugbot PR reviews.

To receive reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.

[mikehardy]

I need to merge this one so I can get it published, otherwise I don't have a good way to verify the gatsby / non-reference website for broken links with a crawler, so remapping reference links is more difficult