Skip to content

docs(firestore): add pipelines overview and SDK compatibility pages#9068

Merged
mikehardy merged 1 commit into
mainfrom
pipeline-docs
Jun 24, 2026
Merged

docs(firestore): add pipelines overview and SDK compatibility pages#9068
mikehardy merged 1 commit into
mainfrom
pipeline-docs

Conversation

@mikehardy

Copy link
Copy Markdown
Collaborator

Description

Adds user-facing Firestore Pipelines documentation: overview page with Enterprise requirements, platform notes, upstream links, YouTube embed, and a findNearest vector search example using lowercase distanceMeasure values; SDK compatibility table vs firebase-js-sdk; sidebar entries under Cloud Firestore. Also fixes broken okf-bundle and /reference links in existing docs.

Related issues

Release Summary

Document Firestore Pipelines (@react-native-firebase/firestore/pipelines) for Enterprise users, including firebase-js-sdk parity notes and vector search guidance.

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

  • yarn lint:js
  • yarn lint:markdown
  • yarn lint:spellcheck
  • audit-docs.page mechanical audit (docs.page CLI, frontmatter, next/previous, Prettier) — all stages passed
  • Visual review: https://rnfirebase.io/~pipeline-docs

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

@gemini-code-assist

Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces documentation for the new Firestore Pipelines feature in React Native Firebase. It provides developers with guidance on Enterprise requirements, platform-specific notes, and usage examples for vector search. Additionally, it improves the documentation structure and resolves several broken links to ensure a better developer experience.

Highlights

  • Firestore Pipelines Documentation: Added comprehensive documentation for Firestore Pipelines, including an overview, Enterprise requirements, and a vector search example.
  • SDK Compatibility: Created a new SDK compatibility page to track parity between React Native Firebase and the firebase-js-sdk for pipeline operations.
  • Navigation and Link Fixes: Updated documentation navigation to include the new pipeline sections and fixed broken links in existing documentation.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces comprehensive documentation for the new Firestore pipeline queries feature in React Native Firebase, adding overview and SDK compatibility guides, updating navigation links, and fixing broken relative links in existing documentation. The review feedback identifies critical errors in the basic code example within the new pipelines documentation: the example incorrectly calls a non-existent .execute() method on the pipeline instance instead of using the standalone execute function, fails to import the execute function, and uses an incorrect option key (fields instead of selection) in the .select() stage.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

Comment thread docs/firestore/pipelines/index.mdx Outdated
Comment thread docs/firestore/pipelines/index.mdx Outdated
Comment thread docs/firestore/pipelines/index.mdx Outdated
@mikehardy mikehardy force-pushed the pipelines-variable-arrayFilter branch from 463f3ab to 4eab922 Compare June 23, 2026 23:03
@mikehardy

Copy link
Copy Markdown
Collaborator Author

big deflake rebased into here, hopefully CI goes green

@mikehardy mikehardy changed the title docs(firestore): add Firestore pipelines documentation docs(firestore): add pipelines overview and SDK compatibility pages Jun 23, 2026
@mikehardy mikehardy force-pushed the pipeline-docs branch 2 times, most recently from b9d2528 to 146d378 Compare June 24, 2026 01:15
@codecov

codecov Bot commented Jun 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 63.55%. Comparing base (cbe2593) to head (f3d8921).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9068      +/-   ##
==========================================
+ Coverage   62.50%   63.55%   +1.06%     
==========================================
  Files         256      319      +63     
  Lines       12714    21883    +9169     
  Branches     3023     3932     +909     
==========================================
+ Hits         7945    13905    +5960     
- Misses       4755     7571    +2816     
- Partials       14      407     +393     
Flag Coverage Δ
e2e-ts-ios 65.01% <ø> (?)
ios-native 65.01% <ø> (?)
jest 62.50% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Base automatically changed from pipelines-variable-arrayFilter to main June 24, 2026 22:25
Introduce user-facing Firestore Pipelines documentation: overview with
Enterprise requirements, platform notes, upstream links, findNearest vector
search example, and firebase-js-sdk parity table. Add sidebar entries under
Cloud Firestore. Fix broken okf-bundle and /reference links in existing docs.
Ignore agent audit reports under .agents/reports/.
@mikehardy mikehardy merged commit 34fce0e into main Jun 24, 2026
22 checks passed
@mikehardy mikehardy deleted the pipeline-docs branch June 24, 2026 22:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant