Clean and fine-tune the examples repo: problem-first READMEs (TOW-2417)#6
Conversation
The repo had no root README. This one groups every example by the problem it solves, labels what each needs to run (zero-setup first), and gives a copy-paste quick start. Part of TOW-2417 (clean and fine-tune example apps). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
09 and 16 shipped with zero-byte READMEs. Both now open with the problem, list the exact secrets needed, and show how to run. 15's readme.md is renamed for consistency with every other example. Part of TOW-2417 (clean and fine-tune example apps). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
05, 06, 08, 11, and 13 opened with feature descriptions ("demonstrates
how to…"). Their titles and intros now state the generic problem first
and frame the ticker data as the demo dataset. Directory and app names
are unchanged so existing links from the Tower app keep working.
Part of TOW-2417 (clean and fine-tune example apps).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
04-dlthub-data-pond was a README-only placeholder marked work in progress with no code. The root data/ directory (fedres CSVs, ticker JSON snapshots, japan-trade-stats) and root .dlt/config.toml are not referenced by any example — the dlt examples read from the public s3://mango-public-data bucket and carry their own .dlt configs. Part of TOW-2417 (clean and fine-tune example apps). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The catalog examples read like they need external infrastructure. The catalog is Tower's own: deploying from the Tower app's examples gallery creates it automatically, and the same setup screen can fill required secrets (OPENAI_API_KEY, inference keys) with Tower sandbox values for testing. READMEs for 05, 06, 09, 13 and the root index now say so, while keeping the CLI instructions for that path. Part of TOW-2417 (clean and fine-tune example apps). Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughThe PR expands repository and example documentation, adds guidance for DuckDB, Marimo, and Sling demos, clarifies Tower-hosted Iceberg and sandbox setup, and removes obsolete configuration and bundled ticker data files. ChangesRepository documentation
Lakehouse and AI examples
Orchestration and query examples
Additional demos
Cleanup
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@06-analyze-ticker-data-in-iceberg/README.md`:
- Around line 1-3: Update the README introduction’s privacy wording to state
that data is not manually exported from the lakehouse, rather than claiming it
never leaves the system; retain the description of analysis on the
daily_ticker_data Iceberg table and DeepSeek recommendations.
In `@16-sling-data/README.md`:
- Around line 14-18: Update the README section around the SNOWFLAKE_URL secret
example to warn that inline credentials may be exposed through shell history and
process inspection. Retain the CLI example, but recommend using sandbox or
temporary credentials, or a safer secret-creation method, and explicitly tell
users not to paste production credentials into the command.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 91aac95d-54e8-40a2-ba35-f8c0acc92a41
⛔ Files ignored due to path filters (1)
data/fedres/FRB_G17.csvis excluded by!**/*.csv
📒 Files selected for processing (46)
.dlt/config.toml04-dlthub-data-pond/README.md05-write-ticker-data-to-iceberg/README.md06-analyze-ticker-data-in-iceberg/README.md08-fan-out-ticker-runs/README.md09-run-duckdb-queries-on-iceberg/README.md11-trim-ticker-table/README.md13-ticker-update-agent/README.md15-interactive-marimo-notebook/README.md16-sling-data/README.mdREADME.mddata/fedres/FRB_G17.csv.manualchangedata/fedres/FRB_G17_last10.csv.templatedata/fedres/FRB_G17_last7.csv.templatedata/japan-trade-stats/.gitignoredata/ticker-data/2025-03-18.jsondata/ticker-data/2025-03-19.jsondata/ticker-data/2025-03-20.jsondata/ticker-data/2025-03-21.jsondata/ticker-data/2025-03-22.jsondata/ticker-data/2025-03-23.jsondata/ticker-data/2025-03-24.jsondata/ticker-data/2025-03-25.jsondata/ticker-data/2025-03-26.jsondata/ticker-data/2025-03-27.jsondata/ticker-data/2025-03-28.jsondata/ticker-data/2025-03-29.jsondata/ticker-data/2025-03-30.jsondata/ticker-data/2025-03-31.jsondata/ticker-data/2025-04-01.jsondata/ticker-data/2025-04-02.jsondata/ticker-data/2025-04-03.jsondata/ticker-data/2025-04-04.jsondata/ticker-data/2025-04-05.jsondata/ticker-data/2025-04-06.jsondata/ticker-data/2025-04-07.jsondata/ticker-data/2025-04-08.jsondata/ticker-data/2025-04-09.jsondata/ticker-data/2025-04-10.jsondata/ticker-data/2025-04-11.jsondata/ticker-data/2025-04-12.jsondata/ticker-data/2025-04-13.jsondata/ticker-data/2025-04-14.jsondata/ticker-data/2025-04-15.jsondata/ticker-data/2025-04-16.jsondata/ticker-data/aapl.json
💤 Files with no reviewable changes (34)
- data/ticker-data/2025-04-13.json
- 04-dlthub-data-pond/README.md
- data/ticker-data/aapl.json
- data/ticker-data/2025-04-02.json
- data/ticker-data/2025-04-04.json
- data/ticker-data/2025-04-09.json
- data/ticker-data/2025-04-11.json
- data/ticker-data/2025-03-21.json
- data/ticker-data/2025-03-22.json
- data/ticker-data/2025-04-15.json
- data/ticker-data/2025-03-24.json
- data/ticker-data/2025-03-19.json
- data/ticker-data/2025-03-25.json
- data/ticker-data/2025-03-29.json
- .dlt/config.toml
- data/ticker-data/2025-04-14.json
- data/ticker-data/2025-03-26.json
- data/japan-trade-stats/.gitignore
- data/ticker-data/2025-04-16.json
- data/ticker-data/2025-04-10.json
- data/ticker-data/2025-04-05.json
- data/ticker-data/2025-04-08.json
- data/ticker-data/2025-03-30.json
- data/ticker-data/2025-03-27.json
- data/ticker-data/2025-04-12.json
- data/ticker-data/2025-04-01.json
- data/ticker-data/2025-03-23.json
- data/ticker-data/2025-03-31.json
- data/ticker-data/2025-04-03.json
- data/ticker-data/2025-03-20.json
- data/ticker-data/2025-03-18.json
- data/ticker-data/2025-04-06.json
- data/ticker-data/2025-04-07.json
- data/ticker-data/2025-03-28.json
…ene note 06's intro claimed data is analyzed "without exporting it anywhere", but the app sends derived metrics to the inference provider in the prompt — reworded to say no export pipeline is needed while being accurate about what leaves the lakehouse. 16 gains a note warning against putting production credentials in shell commands. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
bradhe
left a comment
There was a problem hiding this comment.
Good improvements from my perspective!
What this does
Part of TOW-2417 ("Clean and fine-tune example apps"). Five isolated commits:
readme.md→README.mdfor consistency.sourceUrilinks in the Tower app's example catalog keep working.04-dlthub-data-pondstub, and the unreferenced rootdata/and.dlt/directories.Review notes
data/snapshots (fedres, ticker JSON, japan-trade-stats) are still needed somewhere, that commit can be dropped independently.Summary by CodeRabbit
Summary by CodeRabbit
Documentation
Chores