Add a README for the kits directory - #2976
Merged
Merged
Conversation
Explains what a kit is, lists the kits with links to their READMEs, and covers the firebase.json kit stanza and instance ids. Links to it from the root README.
IzaakGough
marked this pull request as ready for review
August 25, 2026 10:33
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request introduces documentation for Firebase Function Kits, adding a new README in the kits directory and updating the main README to explain how kits work, how to use them, and how to migrate from extensions. The review feedback focuses on improving the documentation's clarity, grammar, and consistency, including suggestions to use more idiomatic phrasing, standardizing terminology (such as 'deployment schedule', 'ID', and 'behavior'), and fixing placeholder formatting.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
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
2 participants
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.
The
kitsdirectory had no README, so there was nothing explaining what a kit is or how the pieces fit together, and the root README did not mention kits at all.Adds
kits/README.md: what a kit is compared with an installed extension, a table of the 13 kits linking to their own READMEs, thefirebase.jsonkitstanza with instance ids and thekitsexperiment, and a short note on what to check when moving off an installed extension. The root README gets one paragraph linking to it.Content is drawn from the kit READMEs and
package.jsonfiles in the tree, not from reading each kit's source. Two things a reviewer may want to weigh in on:npm install @firebase/<name>, but everypackage.jsondeclares@firebase-function-kits/<name>. Since I could not tell which is intended, the new README has no install command. Worth resolving separately.package.jsondescriptions, lightly trimmed.