Skip to content

docs: use docs.page to host docs, with typedoc to generate reference API#8886

Open
mikehardy wants to merge 18 commits intomainfrom
docs.page
Open

docs: use docs.page to host docs, with typedoc to generate reference API#8886
mikehardy wants to merge 18 commits intomainfrom
docs.page

Conversation

@mikehardy
Copy link
Collaborator

Description

The goal here is a new documentation site, the big ideas are as related in the title:

  • docs.page used for hosting, built dynamically from docs/ here
  • reference API pre-built and committed to docs/reference, based on it's own tsconfig and typedoc config, set up to generate MDX that docs.page can consume

It's ready to look at here: https://docs.page/invertase/react-native-firebase~docs.page

Remaining thoughts:

  • Release: rnfirebase.io should be set up as a custom domain with docs.page - this will need some Invertase mgmt intervention
  • Release: Vercel should be turned off for react-native-firebase
  • Automate typedoc reference API generation: the typedocs prebuild + commit should happen as part of the publish workflow, in my opinion. Keeping the generated reference API in sync with the current release vs updating as PRs land seems most correct.
  • make the generated typedocs "feel" better - they currently are very poorly crosslinked and missing types. This will be an ongoing process
  • the main docs and examples should be converted to modular APIs

Related issues

This became important with the conversion to typescript - currently the reference API does not generate API docs for typescript-converted modules, so they are no longer visible on rnfirebase.io

It seemed infeasible to get the existing typedoc -> json -> gatsby API document pipeline working for the new typescript modules, though some effort was expended in the attempt. In fact, the newer versions of typedoc generate JSON output that the current gatsby API document parsing cannot handle at all, so the whole system would need forward-porting which seems like a malinvestment vs docs.page / typedoc+markdown-plugin

Release Summary

docs only

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


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

@vercel
Copy link

vercel bot commented Feb 13, 2026

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

Project Deployment Actions Updated (UTC)
react-native-firebase Ready Ready Preview, Comment Feb 13, 2026 5:26pm

Request Review

@github-actions
Copy link

Hello 👋, this PR has been opened for more than 14 days with no activity on it.

If you think this is a mistake please comment and ping a maintainer to get this merged ASAP! Thanks for contributing!

You have 7 days until this gets closed automatically

@github-actions github-actions bot added the Stale label Feb 27, 2026
@mikehardy
Copy link
Collaborator Author

Been thinking about this one and I must admit I'm not super pleased with how docs.page handles typedoc - it really isn't great unfortunately and I can't get past it - I'm thinking of a hybrid solution that uses raw HTML typedoc output on a gh-pages branch served by github, and docs.page for the rest

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants