Conversation
- avoid raw & - avoid raw < > notations (use backticks) - avoid naked links - avoid raw function notation, use backticks
- add markdown plugin for typedoc - configure markdown plugin for typedoc reference docs
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
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 |
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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The goal here is a new documentation site, the big ideas are as related in the title:
docs/heredocs/reference, based on it's own tsconfig and typedoc config, set up to generate MDX that docs.page can consumeIt's ready to look at here: https://docs.page/invertase/react-native-firebase~docs.page
Remaining thoughts:
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
AndroidiOSOther(macOS, web)e2etests added or updated inpackages/\*\*/e2ejesttests added or updated inpackages/\*\*/__tests__Test Plan
Think
react-native-firebaseis great? Please consider supporting the project with any of the below:React Native FirebaseandInvertaseon Twitter