feat(docs): add developer documentation #9241
Draft
Conversation
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
|
Contributor
Size Report 1Affected ProductsNo changes between base commit (8e26a55) and merge commit (d4be03c).Test Logs |
Contributor
Size Analysis Report 1Affected ProductsNo changes between base commit (8e26a55) and merge commit (d4be03c).Test Logs |
ehsannas
approved these changes
Sep 23, 2025
Contributor
ehsannas
left a comment
ehsannas
left a comment
There was a problem hiding this comment.
Looks good. A few minor comments below.
Contributor
Changeset File Check ✅
|
This commit introduces a new developer documentation hub under the `devdocs` directory. The goal of this new documentation is to provide a comprehensive resource for developers working on the Firestore JS SDK. The new documentation includes: - **Overview:** A high-level overview of the SDK, its goals, and architecture. - **Prerequisites:** A guide for new contributors, outlining the necessary skills and knowledge. - **Architecture:** A detailed explanation of the SDK's architecture, core components, and data flow. - **Code Layout:** A document that explains the structure of the codebase. - **Build & Testing:** Initial documents for the build and testing processes.
Updated to provide a detailed explanation of the 'Overlays' component within the Local Store, describing its purpose as a performance-optimizing cache for pending mutations. Also updated to consistently list 'Overlays' as a component of the directory, aligning with the architectural overview.
Adds new documentation and updates existing documentation for Firestore data bundles. The new `bundles.md` file provides a deep dive into the concept of bundles, their primary use case for SSR hydration, and other benefits. The `architecture.md` file has been updated to include a high-level overview of bundles and their data flow, consistent with the rest of the document.
The new `bundles.md` file provides a deep dive into the concept of bundles, their primary use case for SSR hydration, and other benefits. The `architecture.md` file has been updated to include a high-level overview of bundles and their data flow, consistent with the rest of the document.
Refines the introductory sentence of to reflect a high-level overview. Updates the command description and prompt for clarity and broader applicability.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Refines the introductory sentence of to reflect a high-level overview. Updates the command description and prompt for clarity and broader applicability.
This commit introduces a new developer documentation hub under the `devdocs` directory. The goal of this new documentation is to provide a comprehensive resource for developers working on the Firestore JS SDK. The new documentation includes: - **Overview:** A high-level overview of the SDK, its goals, and architecture. - **Prerequisites:** A guide for new contributors, outlining the necessary skills and knowledge. - **Architecture:** A detailed explanation of the SDK's architecture, core components, and data flow. - **Code Layout:** A document that explains the structure of the codebase. - **Build & Testing:** Initial documents for the build and testing processes.
rafikhan
force-pushed
the
khanrafi/docs
branch
from
f702554 to
83bc62d
Compare
Create a new transactions.md document detailing the implementation of optimistic concurrency control, retries, and the online-only write pipeline for transactions. Update architecture.md and overview.md to reference the new documentation.
Create limbo-resolution.md to detail how the SDK handles offline drift, existence filters, and bloom filters. Update overview.md and query-lifecycle.md to link to the new guide.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
This commit introduces a new developer documentation hub under the
devdocsdirectory. The goal of this new documentation is to provide a comprehensive resource for developers working on the Firestore JS SDK.The new documentation includes: