docs: add showcase examples with screenshots for examples page#292
docs: add showcase examples with screenshots for examples page#292arora-saurabh448 merged 1 commit intomainfrom
Conversation
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>
📝 WalkthroughWalkthroughThe 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment |
There was a problem hiding this comment.
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
⛔ Files ignored due to path filters (6)
docs/docs/assets/images/ADF_Snowflake_Pipeline.pngis excluded by!**/*.pngdocs/docs/assets/images/dbrx_snowflake_benchmark.pngis excluded by!**/*.pngdocs/docs/assets/images/global_co_explorer.pngis excluded by!**/*.pngdocs/docs/assets/images/nyc_taxi.pngis excluded by!**/*.pngdocs/docs/assets/images/spotify_analytics.pngis excluded by!**/*.pngdocs/docs/assets/images/us_home_sales.pngis 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. |
There was a problem hiding this comment.
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.
| > 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".
✅ Tests — All PassedTypeScript — passedcc @arora-saurabh448 |
Summary
Test plan
🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation