Skip to content

docs: add showcase examples with screenshots for examples page#292

Merged
arora-saurabh448 merged 1 commit intomainfrom
chore/add-examples
Mar 19, 2026
Merged

docs: add showcase examples with screenshots for examples page#292
arora-saurabh448 merged 1 commit intomainfrom
chore/add-examples

Conversation

@arora-saurabh448
Copy link
Collaborator

@arora-saurabh448 arora-saurabh448 commented Mar 19, 2026

Summary

  • Replace generic bulleted grid cards with six detailed showcase examples, each with a real prompt and screenshot
  • Examples added: NYC Taxi, Olist E-Commerce, Global CO2 Explorer, Spotify Analytics Migration, US Home Sales Data Science, and Snowflake vs Databricks Benchmark

Test plan

  • Verify all six screenshot images render correctly on the examples page
  • Confirm page layout and card formatting looks correct

🤖 Generated with Claude Code

Summary by CodeRabbit

Documentation

  • Updated examples with six new real-world scenarios: NYC Taxi Coverage Dashboard, Olist E-Commerce Analytics Pipeline, Global CO2 & Climate Explorer, Spotify Analytics Pipeline Migration, US Home Sales Data Science Dashboard, and Snowflake vs Databricks Deployment Benchmark. Each includes updated technology stacks and visual references.

Replace the generic bulleted grid cards with six detailed showcase examples,
each with a real prompt and screenshot: NYC Taxi, Olist E-Commerce, Global CO2
Explorer, Spotify Analytics Migration, US Home Sales Data Science, and
Snowflake vs Databricks Benchmark.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link

@claude claude bot left a comment

Choose a reason for hiding this comment

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

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review.

@coderabbitai
Copy link

coderabbitai bot commented Mar 19, 2026

📝 Walkthrough

Walkthrough

The documentation's example section was restructured, replacing a grid-based HTML layout with markdown sections. Six outdated example topics covering dbt automation, Snowflake debugging, and migration workflows were replaced with six new examples spanning taxi analytics, e-commerce pipelines, climate data, and deployment comparisons.

Changes

Cohort / File(s) Summary
Documentation Examples Update
docs/docs/examples/index.md
Replaced six outdated examples with six new use case examples. Converted HTML grid layout to markdown sections. Each new example includes updated technology stacks, a Prompt block, and image references (NYC Taxi, Olist E-Commerce, CO2 Climate, Spotify Analytics, US Home Sales, Snowflake vs Databricks).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 The docs hop forward, examples bright,
Six new tales under spotlight,
From taxis, commerce, climate air,
To analytics beyond compare,
Markdown neat, the grid's now gone,
Documentation carries on! 📚✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title directly matches the main change: replacing generic cards with showcase examples that include screenshots on the examples page.
Description check ✅ Passed The description covers the summary and test plan sections from the template, though the checklist section is missing and test items are not marked as complete.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/add-examples
📝 Coding Plan
  • Generate coding plan for human review comments

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/docs/examples/index.md`:
- Line 61: Update the phrasing to hyphenate the compound modifiers: change "data
science style charts" to "data-science-style charts" and "BI style charts" to
"BI-style charts" in the index.md content so the compound adjectives correctly
modify "charts".
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 693aa1a5-354b-434b-84af-3678438524d2

📥 Commits

Reviewing files that changed from the base of the PR and between 53c38a8 and 043395f.

⛔ Files ignored due to path filters (6)
  • docs/docs/assets/images/ADF_Snowflake_Pipeline.png is excluded by !**/*.png
  • docs/docs/assets/images/dbrx_snowflake_benchmark.png is excluded by !**/*.png
  • docs/docs/assets/images/global_co_explorer.png is excluded by !**/*.png
  • docs/docs/assets/images/nyc_taxi.png is excluded by !**/*.png
  • docs/docs/assets/images/spotify_analytics.png is excluded by !**/*.png
  • docs/docs/assets/images/us_home_sales.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • docs/docs/examples/index.md


**Prompt:**

> Download all available public US home sales data sets. Process and merge them into a unified format. Perform advanced data science on it to bring to the surface interesting insights. K-means, OLS regressions, and more. Build a single interactive dashboard with data science style charts, think violin plots, Q-Q plots and lollipop charts. Use a R/ggplot2 aesthetic. No BI style charts.
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix compound modifier hyphenation.

The phrases "data science style charts" and "BI style charts" should use hyphens to join the compound modifiers before the noun. As per static analysis hints, compound modifiers require hyphenation.

📝 Proposed fix
-> Download all available public US home sales data sets. Process and merge them into a unified format. Perform advanced data science on it to bring to the surface interesting insights. K-means, OLS regressions, and more. Build a single interactive dashboard with data science style charts, think violin plots, Q-Q plots and lollipop charts. Use a R/ggplot2 aesthetic. No BI style charts.
+> Download all available public US home sales data sets. Process and merge them into a unified format. Perform advanced data science on it to bring to the surface interesting insights. K-means, OLS regressions, and more. Build a single interactive dashboard with data-science-style charts, think violin plots, Q-Q plots and lollipop charts. Use a R/ggplot2 aesthetic. No BI-style charts.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
> Download all available public US home sales data sets. Process and merge them into a unified format. Perform advanced data science on it to bring to the surface interesting insights. K-means, OLS regressions, and more. Build a single interactive dashboard with data science style charts, think violin plots, Q-Q plots and lollipop charts. Use a R/ggplot2 aesthetic. No BI style charts.
> Download all available public US home sales data sets. Process and merge them into a unified format. Perform advanced data science on it to bring to the surface interesting insights. K-means, OLS regressions, and more. Build a single interactive dashboard with data-science-style charts, think violin plots, Q-Q plots and lollipop charts. Use a R/ggplot2 aesthetic. No BI-style charts.
🧰 Tools
🪛 LanguageTool

[grammar] ~61-~61: Use a hyphen to join words.
Context: ... interactive dashboard with data science style charts, think violin plots, Q-Q pl...

(QB_NEW_EN_HYPHEN)


[grammar] ~61-~61: Use a hyphen to join words.
Context: ...charts. Use a R/ggplot2 aesthetic. No BI style charts. ![US Home Sales Dashboard...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/docs/examples/index.md` at line 61, Update the phrasing to hyphenate the
compound modifiers: change "data science style charts" to "data-science-style
charts" and "BI style charts" to "BI-style charts" in the index.md content so
the compound adjectives correctly modify "charts".

@dev-punia-altimate
Copy link

✅ Tests — All Passed

TypeScript — passed

cc @arora-saurabh448
Tested at 043395f5 | Run log | Powered by QA Autopilot

Copy link
Collaborator Author

@arora-saurabh448 arora-saurabh448 left a comment

Choose a reason for hiding this comment

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

lgtm!

@arora-saurabh448 arora-saurabh448 merged commit ba6631a into main Mar 19, 2026
13 checks passed
@arora-saurabh448 arora-saurabh448 deleted the chore/add-examples branch March 19, 2026 06:07
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.

3 participants