-
Notifications
You must be signed in to change notification settings - Fork 924
Docs: mark methods and products that don't work in Node #7276
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Size Report 1Affected ProductsNo changes between base commit (8421ba1) and merge commit (b0ef014).Test Logs |
Size Analysis Report 1Affected ProductsNo changes between base commit (8421ba1) and merge commit (b0ef014).Test Logs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm, except for one comment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We also chatted about this offline, but added my observations here too. Thanks for sending this PR!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I opened 7299 with additional changes for Firestore. But otherwise, Firestore looks good to me.
… be used in Node.js environments.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
We want to get rid of the "Node.js (Client)" sidebar entry in the reference docs and have one unified entry each for modular (the entry called "Javascript - modular") and compat (the entry called ("Javascript - compat (namespaced)"). Modular already did not have a separate entry for Node.
The only difference between the namespaced "JavaScript - compat" and namespaced "Node" docs were that the "Node" docs had some methods and products removed, as they don't work in Node.
This PR adds sentences on each product and method that doesn't work in Node, allowing us to use one set of docs for both "browser" and "Node" users (and any other environments).
The content changes are:
Script changes are:
scripts/docgen-compat
)Some tips for parsing:
packageDocumentation
tag is text that appears at the top of a product's main index pagepackages/firebase/compat/index.d.ts
which is the sole source of truth for compat docs. That file already had non-Node APIs marked with a@webonly
tag which allowed the documentation tool to filter them out when creating the separate Node docs. I replaced those tags with text that will be visible in the reference docs.@remarks
tag means that everything after it is excluded from table of contents entries, to save space, but appears in the full description of the item itself.