Skip to content

Add crashlytics sdk setup guides to readmes - #10215

Merged
tonybaroneee merged 5 commits into
crashlytics2from
crash-setup-docs
Jul 30, 2026
Merged

Add crashlytics sdk setup guides to readmes#10215
tonybaroneee merged 5 commits into
crashlytics2from
crash-setup-docs

Conversation

@tonybaroneee

@tonybaroneee tonybaroneee commented Jul 27, 2026

Copy link
Copy Markdown

@tonybaroneee
tonybaroneee requested a review from a team as a code owner July 27, 2026 17:12
@changeset-bot

changeset-bot Bot commented Jul 27, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 2e74979

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@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 setup guides and documentation for Firebase Crashlytics for Web Apps, covering frameworks like Angular, Next.js, React, and React Router, along with reusable documentation partials. The review feedback highlights several critical issues in the documentation examples: incorrect shell variable placeholders and unquoted JSON values in the main README, a misleading comment regarding log exclusion levels, a Next.js serialization runtime error caused by passing a non-serializable FirebaseApp instance in a Server Component layout, and a copy-pasted Next.js layout example in the standard React guide.

Comment thread packages/crashlytics/README.md Outdated
Comment thread packages/crashlytics/README.md Outdated
Comment thread packages/crashlytics/README.md Outdated
Comment thread packages/crashlytics/README.md Outdated
Comment thread packages/crashlytics/README.md Outdated
Comment thread packages/crashlytics/README.md Outdated
Comment thread packages/crashlytics/src/next/README.md Outdated
Comment thread packages/crashlytics/src/react/README.md Outdated
Comment thread packages/crashlytics/src/react-router/README.md Outdated
Comment thread packages/crashlytics/docs/_force_flushing.md Outdated

@PolinaGo PolinaGo left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Reviewing files 1-by-1, starting with the top one

Comment thread packages/crashlytics/README.md
Comment thread packages/crashlytics/README.md Outdated
Comment thread packages/crashlytics/README.md Outdated
Comment thread packages/crashlytics/README.md Outdated
Comment thread packages/crashlytics/README.md Outdated
Comment thread packages/crashlytics/README.md Outdated
Comment thread packages/crashlytics/partials/_gotchas_absence_of_log.md Outdated
Comment thread packages/crashlytics/docs/_custom_attribute_collection.md Outdated
Comment thread packages/crashlytics/README.md Outdated
Comment thread packages/crashlytics/README.md
@tonybaroneee
tonybaroneee requested review from PolinaGo and jwolfson-goog and removed request for rebehe July 29, 2026 13:39
@tonybaroneee
tonybaroneee force-pushed the crash-setup-docs branch 2 times, most recently from 5addaa6 to 5d82cbc Compare July 29, 2026 13:56
@tonybaroneee

tonybaroneee commented Jul 29, 2026

Copy link
Copy Markdown
Author

@jwolfson-goog @PolinaGo

📝 Overview of Changes & Review Feedback Addressed

1. Project Configuration & Setup Flow

  • Automated Firebase Console Setup: Promoted the automated setup via the Firebase Console Crashlytics page as Option 1 (recommended).
  • Removed Cloud Console UI Steps: Removed manual Cloud Console UI setup steps to streamline instructions while keeping the gcloud CLI steps (Option 2) for command-line and agent-driven workflows.
  • Firebase Terms of Service Note: Added a note reminding users onboarding from existing Google Cloud projects to accept the Firebase Terms of Service in the Firebase Console prior to setup.
  • Sequential Flow: Restructured the setup into logical steps (Step 1: Project Setup, Step 2: Core SDK Setup, Step 3: Framework Integration) with an explicit note requiring Steps 1 & 2 to be completed first.

2. EAP Access & Prompt Updates

  • EAP Notice: Added a private preview notice at the top of the README with a link to the EAP sign-up form.
  • Agent Setup Prompt: Made the entire Agent Setup Prompt block copy-able in a single snippet and updated instructions to point to the GitHub README files instead of PDF documents.

3. Framework-Specific Guides & Documentation Layout

  • TanStack Router: Moved TanStack Router setup into its own dedicated guide (packages/crashlytics/src/tanstack/README.md) and kept react-router/README.md focused on React Router v6+.
  • Folder & File Renaming:
    • Renamed the partials/ directory to docs/ and updated .gitignore rules so files are tracked.
    • Renamed _gotchas_absence_of_log.md to _custom_attribute_collection.md and updated the section heading to Custom Attributes in the Absence of log() Method.
    • Moved Alerting, Sampling, Telemetry Collection, Log Schema, and App Versioning into standalone doc files under docs/ and linked to them under Additional Configuration & References.
  • Cleanup: Removed the duplicate Feedback & Support section at the end of the README.

@tonybaroneee
tonybaroneee requested review from OrlandriaH-G and jwolfson-goog and removed request for jwolfson-goog July 29, 2026 14:23
Comment thread packages/crashlytics/README.md Outdated
@tonybaroneee
tonybaroneee merged commit ef01c9f into crashlytics2 Jul 30, 2026
43 of 44 checks passed
@tonybaroneee
tonybaroneee deleted the crash-setup-docs branch July 30, 2026 12:34
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.

4 participants