Skip to content

Docs: Improve 'Deploy with Firebase' page for users new to Firebase #120

@LyalinDotCom

Description

@LyalinDotCom

The current "Deploy with Firebase" documentation page is a good technical reference for someone who is already familiar with Firebase, but it falls short for a developer who may have discovered Genkit first and is now exploring deployment options.

The document jumps directly into the implementation details of onCallGenkit without first establishing the foundational "why." We can't assume a user coming from the Genkit ecosystem will understand what Firebase Functions are, what a "callable function" is, or why this is an advantageous way to deploy their flows.

Deployment is a critical, high-value scenario for developers. It's also a key opportunity for us to guide Genkit users into the Firebase ecosystem. To make this page more effective, we need to add more context and structure it as a complete, end-to-end tutorial.

Recommendations for Improvement:

  1. Add an Introductory Section:

    • Start with a brief, high-level explanation of what Cloud Functions for Firebase is (e.g., a serverless framework for running backend code in response to events or HTTP requests).
    • Explain the primary benefit of using the onCallGenkit wrapper: it creates a "callable function." We should explain that this provides a simple and secure endpoint for their flows that can be easily called from a web or mobile app using the Firebase client SDKs. Emphasize that the SDKs automatically handle passing user authentication tokens, which simplifies securing the endpoint.
  2. Re-evaluate the "Before you begin" Section:

    • This section should explicitly state that no prior Firebase experience is necessary. Instead of saying it's "helpful," we should frame it as a guide that will walk them through the entire process from scratch.
  3. Structure as a Complete Tutorial:

    • The "Optional: Try the deployed flow" section is arguably the most important part of the document, as it shows the full value of the integration. This should be reframed as the final step of the main tutorial, not an optional aside.
    • The goal of the page should be to guide a user through a complete journey:
      1. Initialize a new Firebase project with Genkit.
      2. Write a simple Genkit flow.
      3. Wrap it with onCallGenkit and configure security.
      4. Deploy the function.
      5. Create a simple web client that calls the deployed function.

By providing this context and a more robust, tutorial-style structure, we can create a much more effective and welcoming onboarding path for new users, successfully demonstrating the power of using Genkit and Firebase together.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions