docs: update start-free-with-cloud guide to align with new onboarding flow #43

even-wei · 2025-10-20T06:53:58Z

Summary

Restructured the "Start Free with Recce Cloud" documentation to match the actual user onboarding journey in the product.

Key Changes

Structure

Reorganized from feature-based to step-based flow (Step 1 → Step 2 → Advanced Features)
Moved GitHub integration to Step 1 (first action after signup)
Consolidated CI/CD automation into Step 2
Moved data warehouse diffing to Advanced Features section

Content Improvements

Simplified benefits lists and removed redundant items
Removed marketing language (team plan mentions, trial references)
Streamlined requirements sections for clarity
Added side-by-side image layout for better visual presentation
Fixed typo: "To easy validation" → "To enable easy validation"

Removed

Manual metadata upload instructions (moved CI/CD focus earlier)
Redundant note boxes about permissions and team plans
Overly detailed workflow descriptions

Impact

Better alignment with actual product onboarding flow
Clearer path for new users (3 simple steps)
Reduced cognitive load with simplified content
Improved visual presentation with image layout

Test Plan

Review documentation structure matches product UI flow
Verify all internal links work correctly
Confirm images display properly side-by-side
Check that setup guides are accessible

🤖 Generated with Claude Code

… flow Restructured the "Start Free with Recce Cloud" documentation to align with the new user onboarding journey where users first connect GitHub, then configure CI/CD automation, followed by optional warehouse connection. Key changes: - Reordered sections: GitHub Integration → CI/CD Automation → Data Warehouse Diffing - Removed manual metadata upload instructions (now automated via CI/CD) - Simplified "Connection Steps" to rely on in-app guidance with visual screenshots - Added three new screenshots showing GitHub connection flow - Converted JPEG images to PNG format for consistency - Fixed URL inconsistency (cloud.datarecce.io → cloud.reccehq.com) - Moved Data Warehouse Diffing to "Advanced Features" section - Added "What You'll Get" sections to clarify value at each step - Updated setup requirements to reflect progressive enhancement model The new structure guides users through: 1. Step 1: Connect GitHub (view PRs with limited summaries) 2. Step 2: Automate CI/CD (unlock full-featured summaries + Launch Recce) 3. Advanced: Add warehouse connection (enable data diffing) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: even-wei <evenwei@infuseai.io>

Streamline onboarding documentation for better clarity: - Simplify benefits lists and remove redundant items - Remove marketing language (team plan mentions) - Fix typo: "To easy validation" → "To enable easy validation" - Add side-by-side image layout for better visual presentation - Make requirements more concise and clearer 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com> Signed-off-by: even-wei <evenwei@infuseai.io>

ijac13 · 2025-10-20T07:09:32Z

docs/2-getting-started/start-free-with-cloud.md

+Follow the guidance to connect your GitHub organization and link your repository:

-### Required Files
+![Connect GitHub](../assets/images/2-getting-started/connect_github.png){ width="49%" }


@even-wei I thought we agreed on moving the Connect button to the top above the Step 1

Oh, yes, I will update it.

ijac13 · 2025-10-20T07:11:52Z

docs/2-getting-started/start-free-with-cloud.md

+![Link Repository](../assets/images/2-getting-started/link_repository.png){ width="49%" }

-Recce needs `manifest.json` and `catalog.json` from both **base** and **current** environments for comparison.
+Once connected, your PRs will appear in the dashboard with basic change summaries:


"with basic change summaries:"

do users see the summary automatically or they need to click the "Summarize"

The need to click "Summarize", how about

Once connected, your PRs will appear in the dashboard, and you can summarize them:

ijac13 · 2025-10-20T07:12:33Z

docs/2-getting-started/start-free-with-cloud.md


+- Automatic metadata upload on every PR
+- **One-click "Launch Recce"** to validate changes interactively
+- **Enriched PR summaries** with comprehensive model impact analysis


suggest we remove the ** in line 48 and line 49

ijac13 · 2025-10-20T07:14:02Z

docs/2-getting-started/start-free-with-cloud.md

-Use development environment or PR branch as current to compare against the base.
+1. **Automatic upload**: Metadata is uploaded to Recce Cloud for both base and current environments
+2. **Ready to validate**: PR appears in your dashboard "Launch Recce" button
+3. **Enriched summaries**: Enriched PR summaries with detailed model impact analysis


line 62, does it mean we support Metadata currently?

not yet, let me remove it and add it back when we support it.

ijac13 · 2025-10-20T07:15:08Z

docs/2-getting-started/start-free-with-cloud.md

+The CI/CD integration automates the metadata upload process:

-Use development environment or PR branch as current to compare against the base.
+1. **Automatic upload**: Metadata is uploaded to Recce Cloud for both base and current environments


Suggest we align the environments name with the UI. We have production Metadata and PR sessions on UI, but no "base" and "current" environments

Good point, I will align it

ijac13

@even-wei I leave a few comments, please check

ijac13 · 2025-10-20T07:19:45Z

docs/2-getting-started/start-free-with-cloud.md

-Deploy → Jobs → CI job → Recent run → Download artifacts
+<!-- insert a video -->

+## Advanced Features


I think we can get rid of this line, and replace it with something like "You have the metadata, the next is to have data diffing. See Data Diffing"

and then make Data diffing to a stand alone page.

sorry, I think we can remove all these after line 73 since there is https://docs.reccehq.com/5-data-diffing/connect-to-warehouse/

even-wei and others added 2 commits October 17, 2025 17:05

ijac13 reviewed Oct 20, 2025

View reviewed changes

ijac13 requested changes Oct 20, 2025

View reviewed changes

ijac13 reviewed Oct 20, 2025

View reviewed changes

Uh oh!

docs: update start-free-with-cloud guide to align with new onboarding flow #43

Are you sure you want to change the base?

docs: update start-free-with-cloud guide to align with new onboarding flow #43

Uh oh!

Conversation

even-wei commented Oct 20, 2025

Summary

Key Changes

Impact

Test Plan

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ijac13 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants