feat(docs): add developer documentation #9241
Draft
+297
−0
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
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.
|
Size Report 1Affected Products
Test Logs |
Size Analysis Report 1This report is too large (212,591 characters) to be displayed here in a GitHub comment. Please use the below link to see the full report on Google Cloud Storage.Test Logs |
ehsannas
approved these changes
Sep 23, 2025
|
|
||
| 1. **API Layer**: A user initiates a write operation (e.g., `setDoc`, `updateDoc`, `deleteDoc`). | ||
| 2. **Sync Engine**: The call is routed to the Sync Engine, which wraps the operation in a "mutation". | ||
| 3. **Mutation Queue (in Local Store)**: The Sync Engine adds this mutation to the Mutation Queue. The queue is persisted to the **Persistence Layer** (IndexedDB). At this point, the SDK "optimistically" considers the write successful locally. |
There was a problem hiding this comment.
Overlays were added which is missing from the diagram and the description.
|
|
||
| The SDK is composed of several key components that work together to provide the full range of Firestore features. | ||
|
|
||
|  |
There was a problem hiding this comment.
I wonder if a graphviz dot representation of the diagram would be better to use rather than a png file.
Comment on lines
+31
to
+43
| TODO: Add critical information about the build process including optimizations for code size, etc. | ||
|
|
||
| For information on how the artifacts are built, please see the [Build documentation](./build.md) file. | ||
|
|
||
| ## Testing | ||
|
|
||
| TODO: Add critical information about the tests harness, organization, spec tests, etc. | ||
|
|
||
| For information on how the tests are setup and organized [Testing documentation](./testing.md) file. | ||
|
|
||
| ## Developer Workflow | ||
|
|
||
| TODO: Add list of common commands here. |
There was a problem hiding this comment.
Fill in the remaining TODOs (or remove the incomplete sections for now?)
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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: