Skip to content

Docs v3: Rewrite start-free-with-cloud as overview + router page#87

Open
doriwilson wants to merge 62 commits intomainfrom
docs-v3
Open

Docs v3: Rewrite start-free-with-cloud as overview + router page#87
doriwilson wants to merge 62 commits intomainfrom
docs-v3

Conversation

@doriwilson
Copy link
Contributor

Summary

This PR rewrites start-free-with-cloud.md from a ~350-line mega-page into a ~160-line overview + router page. The previous version duplicated YAML code blocks and configuration instructions already covered by dedicated setup pages. The rewrite removes all duplication and routes users to spoke pages instead.

  • 351 → 160 lines (54% reduction)
  • All YAML code blocks removed (profiles.yml, base-workflow.yml, pr-workflow.yml)
  • Hub-and-spoke navigation with breadcrumb admonitions on spoke pages
  • Fixed env var inconsistency (CI_SCHEMASNOWFLAKE_SCHEMA)
  • Fixed workflow name mismatch in verification step

What changed vs earlier docs-v3

start-free-with-cloud.md (primary rewrite)

Removed:

  • profiles.yml YAML block + explanation (~40 lines) — already in environment-setup.md
  • base-workflow.yml YAML block + explanation (~55 lines) — already in setup-cd.md
  • pr-workflow.yml YAML block + explanation (~55 lines) — already in setup-ci.md
  • "About Secrets" standalone section — retained as one inline sentence
  • "Set Up Profile.yml" section header and walkthrough
  • "Set Up Base Metadata Updates" section header and walkthrough
  • "Set Up Current Metadata Updates" section header and walkthrough
  • recce vs recce-cloud verbose admonition — condensed to one sentence
  • "This guide covers" bullets and verbose goal preamble
  • "[Experimental]" label on Web Agent section
  • "Coming soon" note about agent expansion

Replaced with:

  • Step 3a/b/c: 1-2 sentence descriptions + bold links to environment-setup.md, setup-cd.md, setup-ci.md
  • Steps 1-2: 1 sentence each + links to connect-to-warehouse.md, connect-git.md
  • Router table: updated "Continue with this guide" self-referencing links → plain text "Continue reading below"
  • Next Steps: added descriptions to each link

Kept unchanged:

  • Frontmatter, H1, Get Started button, Loom video embed
  • Prerequisites (4 checkboxes)
  • Onboarding Process Overview (4 steps)
  • Recce Web Agent Setup (3 bullets)
  • "Choose your setup" router table (structure preserved, links updated)
  • Step 4: Merge the CI/CD change + screenshot
  • Step 5: Final Steps
  • Verification Checklist (3 items)
  • Troubleshooting table (6 rows)

environment-setup.md

  • Fix: CI_SCHEMASNOWFLAKE_SCHEMA in profiles.yml example (line 66), env var snippets (lines 96, 103), and prose (lines 84, 109)
  • Fix: pr_123PR_123 in prose to match actual YAML output casing
  • Added: Breadcrumb admonition at top: "Following the onboarding guide? Return to Get Started with Recce Cloud"
  • Added: Note that other warehouses use their own variable name

setup-cd.md

  • Fix: Verification step said "Update Base Recce Session" but workflow YAML defines name: Update Base Metadata — updated to match
  • Added: Breadcrumb admonition at top

setup-ci.md

  • Added: Breadcrumb admonition at top

gitlab-pat-guide.md

  • No changes — existing anchor #2-connect-git-provider still resolves correctly

Review notes

  • Editor review flagged two critical issues (both fixed): self-referencing table links and workflow name mismatch
  • Non-blocking recommendations for follow-up: consistent Base/Current capitalization, rename "Step 5: Final Steps", clarify non-Snowflake variable names

Test plan

  • mkdocs serve renders all 4 changed pages without warnings
  • No YAML code blocks on start-free-with-cloud.md
  • Router table renders correctly
  • Video embed works
  • All internal links clickable (especially #3-add-recce-to-cicd and #2-connect-git-provider anchors)
  • Breadcrumb admonitions on spoke pages link back correctly
  • Prerequisites and verification checklist unchanged

🤖 Generated with Claude Code

ijac13 and others added 30 commits February 27, 2026 21:28
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Tutorial for setting up Recce Cloud when dbt runs on dbt Cloud,
covering artifact retrieval via dbt Cloud API and GitHub Actions
workflow configuration.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Helps users identify their setup path:
- Own dbt run vs platform (dbt Cloud)
- Simple vs advanced environment

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Restructure setup guidance into nested decision tree
- Question 1: Where dbt runs (self-hosted vs dbt Cloud)
  - If self-hosted: sub-options for GitHub Actions vs GitLab/CircleCI
- Question 2: Environment complexity (simple vs advanced)
- Link to dbt Cloud Setup for platform users
- Link to Environment Setup for advanced configurations
- Update environment-setup.md with CI/CD workflow explanation
- Create environment-best-practices.md (from best-practices-prep-env.md)
- Move setup-cd.md to 2-getting-started (for GitLab/CircleCI users)
- Move setup-ci.md to 2-getting-started (for GitLab/CircleCI users)
- Update internal links to new locations
- Add dbt Cloud Setup to mkdocs.yml navigation
- Update setup-cd and setup-ci links to new location (2-getting-started/)
- Remove 'advanced configuration' framing - this is basic setup
- Reorder: 'Why separate schemas' before 'How CI/CD works'
- Reduce profiles.yml to single example with note for other warehouses
- Shorten CI/CD env var examples (full workflows in setup-cd/ci)
- Recommend schema-per-PR as primary pattern
- Add 'not recommended' warning for shared dev schema
- Add pros AND cons for staging-as-base pattern
- setup-cd: References environment-setup, clarifies main branch uses prod target
- setup-ci: References environment-setup, clarifies per-PR schema with ci target
- Both link to environment-setup.md for profiles.yml configuration
- Add problem statement to dbt-cloud-setup opening
- Remove redundant content between intro and goal
- Spell out PR and CI/CD acronyms on first use
- Fix "bolded steps" references to explicit commands
- Improve image alt text for accessibility
- Rename "Related" to "Next steps" with descriptive links

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Standardize PR terminology (remove PR/MR references)
- Add problem statements to openings
- Improve image alt text for accessibility
- Define key terms inline (base/current environment)
- Add "When to use this guide" section to best practices
- Rename "Related" to "Next steps"
- Spell out CI/CD acronyms on first use

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Create oss-setup.md: OSS installation and local validation guide
- Create jaffle-shop-tutorial.md: Hands-on tutorial with DuckDB
- Create cloud-vs-oss.md: Cloud vs Open Source comparison
- Delete old oss-vs-cloud.md and get-started-jaffle-shop.md
- Update navigation in mkdocs.yml

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Create 3-using-recce/admin-setup.md: Organization setup tutorial
- Delete 6-collaboration/invitation.md (replaced by admin-setup)
- Update navigation in mkdocs.yml

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Fix MCP link in cloud-vs-oss.md
- Change prerequisites to checked format [x]
- Change "dbt models" to "data models" for broader audience
- Remove installation.md (content covered in oss-setup.md)
- Update mkdocs.yml navigation

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Redirects:
- installation.md → oss-setup.md
- get-started-jaffle-shop.md → jaffle-shop-tutorial.md
- oss-vs-cloud.md → cloud-vs-oss.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add mkdocs-redirects plugin to requirements.txt
- Add redirects for 7-cicd/ → 2-getting-started/ paths
- Fix broken link to dbt-cloud-setup.md in environment-best-practices.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Remove old 7-cicd/setup-cd.md and setup-ci.md from nav (moved to Getting Started)
- Update links in start-free-with-cloud.md to point to new locations
- Update links in ci-cd-getting-started.md to point to new locations
- Delete old setup-cd.md and setup-ci.md from 7-cicd/

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add step 4 "Rename your project (optional)" with updated instructions
- Renumber "Invite team members" to step 5
- Add step 6 telling admins to inform invitees about acceptance modal
- Remove redundant "Additional Settings > Rename your project" section

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Helps users identify their setup path:
- Own dbt run vs platform (dbt Cloud)
- Simple vs advanced environment

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
ijac13 and others added 30 commits March 3, 2026 17:44
- data-developer.md: Dev sessions (before PR) and CI/CD validation (after PR)
- data-reviewer.md: Review data changes using Recce summaries

Part of docs v3 migration - PR4

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- Add mkdocs-redirects plugin with redirect mappings for all restructured pages
- PR 6: Lineage and data diffing → 5-what-you-can-explore/
- PR 7: preset-checks.md → 6-collaboration/
- PR 8: Technical concepts → 7-reference/
- PR 9: Community support → 8-community/
- Create CLEANUP-TODO.md documenting files to delete after all PRs merge

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Create new 8-community section containing:
- support.md: Consolidated community resources (Discord, Slack, GitHub, social media)
- changelog.md: Links to release notes and detailed blog posts

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
…tation

- Create 7-reference/configuration.md: Document recce.yml preset check
  configuration with overview, parameters, and examples for all check types
- Create 7-reference/state-file.md: Document state file format, saving methods,
  and usage patterns for development and PR review workflows
- Create 7-reference/cli-reference.md: Document recce and recce-cloud CLI
  commands including server, run, summary, debug, and upload
- Update mkdocs.yml: Rename "Technical Concepts" to "Reference" and update
  navigation paths to new 7-reference section

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
PR 2b: Environment Setup + Best Practices + CI/CD Pages
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
PR2d: Add OSS setup guides and Cloud vs OSS comparison

Approving as part of batch merge. These PRs are too interdependent and can't be meaningfully reviewed individually. Will do a full review of the final state after all are merged.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
PR3: Add admin setup guide for team collaboration

Approving as part of batch merge. These PRs are too interdependent and can't be meaningfully reviewed individually. Will do a full review of the final state after all are merged.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
PR5: Add What the Agent Does section

Approving as part of batch merge. These PRs are too interdependent and can't be meaningfully reviewed individually. Will do a full review of the final state after all are merged.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
docs(v3): Add data developer and reviewer workflow guides

Approving as part of batch merge. These PRs are too interdependent and can't be meaningfully reviewed individually. Will do a full review of the final state after all are merged.
Add Community section with support and changelog pages

Approving as part of batch merge. These PRs are too interdependent and can't be meaningfully reviewed individually. Will do a full review of the final state after all are merged.
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add Reference section with CLI, configuration, and state file documentation

Approving as part of batch merge. These PRs are too interdependent and can't be meaningfully reviewed individually. Will do a full review of the final state after all are merged.
PR 10: Cleanup and redirects

Approving as part of batch merge. These PRs are too interdependent and can't be meaningfully reviewed individually. Will do a full review of the final state after all are merged.
Consolidate feature pages into new 5-what-you-can-explore section:
- lineage-diff.md (from 3-visualized-change/lineage.md)
- code-change.md (from 3-visualized-change/)
- column-level-lineage.md (from 3-visualized-change/)
- multi-models.md (from 3-visualized-change/)
- impact-radius.md (from 4-downstream-impacts/)
- breaking-change-analysis.md (from 4-downstream-impacts/)
- data-diffing.md (consolidated from 5-data-diffing/)

Update mkdocs.yml navigation and add redirects for old paths.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Change lineage.md references to lineage-diff.md

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Add missing sections to concept docs:
- breaking-change-analysis.md: When to Use, Related
- code-change.md: When to Use, Related
- column-level-lineage.md: When to Use, Related
- impact-radius.md: When to Use
- multi-models.md: When to Use, Related

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
PR6: Add What You Can Explore section
- checklist.md: Add "When to use" section, restructure as concept
- share.md: Add Goal, Prerequisites, Verification sections
- preset-checks.md: Copy from 7-cicd/, add Goal/Prerequisites/Verification

Part of docs v3 migration - PR7

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
- checklist.md: Add link to Preset Checks in Re-running Checks section
- share.md: Restructure with Recce Cloud first (URL sharing), OSS methods second
- preset-checks.md: Restructure with Recce Cloud first (UI-based), OSS (recce.yml) second
- mkdocs.yml: Remove duplicate preset-checks entry from CI/CD nav

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
docs(v3): Update collaboration pages
- Reduce from 351 to 160 lines by removing duplicated YAML blocks
- Replace inline profiles.yml, base-workflow.yml, pr-workflow.yml with
  links to dedicated pages (environment-setup, setup-cd, setup-ci)
- Fix CI_SCHEMA → SNOWFLAKE_SCHEMA in environment-setup.md for consistency
- Add breadcrumb admonitions to spoke pages (environment-setup, setup-cd,
  setup-ci) for onboarding navigation
- Fix workflow name mismatch in setup-cd.md verification step
- Update router table to use plain text instead of self-referencing anchors

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

2 participants