Skip to content

Clean and fine-tune the examples repo: problem-first READMEs (TOW-2417)#6

Open
giray123 wants to merge 6 commits into
mainfrom
feature/tow-2417-tower-examples-fine-tuning-single-repo-cli-templates
Open

Clean and fine-tune the examples repo: problem-first READMEs (TOW-2417)#6
giray123 wants to merge 6 commits into
mainfrom
feature/tow-2417-tower-examples-fine-tuning-single-repo-cli-templates

Conversation

@giray123

@giray123 giray123 commented Jul 24, 2026

Copy link
Copy Markdown

What this does

Part of TOW-2417 ("Clean and fine-tune example apps"). Five isolated commits:

  1. Add a problem-first root README. The repo had none. It indexes every example by the problem it solves (zero-setup first), with a "what you need" column and a copy-paste quick start.
  2. Fill the empty READMEs for 09 and 16 (both were zero-byte) and rename 15's readme.mdREADME.md for consistency.
  3. Lead the ticker examples (05, 06, 08, 11, 13) with the problem they solve — titles and intros now state the generic problem first, framing ticker data as the demo dataset. Directory and app names are unchanged, so the sourceUri links in the Tower app's example catalog keep working.
  4. Remove dead weight: the README-only WIP 04-dlthub-data-pond stub, and the unreferenced root data/ and .dlt/ directories.
  5. Clarify the Iceberg catalog is Tower-hosted — one-click creation when deploying from the Tower app, sandbox secret values available for testing (06, 13); CLI instructions kept for that path.

Review notes

  • Commit 4 deletes files — if the root data/ snapshots (fedres, ticker JSON, japan-trade-stats) are still needed somewhere, that commit can be dropped independently.
  • 04-dlthub-data-pond can be restored when the reworked dlt example lands.

Summary by CodeRabbit

Summary by CodeRabbit

  • Documentation

    • Added a full “Tower Examples” guide with quick-start steps and organized example listings.
    • Updated multiple example READMEs to clarify goals, prerequisites, and how to deploy/run Iceberg, LLM/agent, DuckDB, fan-out, and notebook demos.
    • Added a new DuckDB-on-Iceberg example README and detailed Sling-to-Snowflake setup instructions.
  • Chores

    • Removed or cleared outdated demo configuration and bundled sample ticker data files.
    • Cleaned up the Data Pond demo documentation.

giray123 and others added 5 commits July 24, 2026 13:03
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>
@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3a74d75e-7c12-43bf-acc3-5f7cc6636149

📥 Commits

Reviewing files that changed from the base of the PR and between d7e5609 and de87329.

📒 Files selected for processing (2)
  • 06-analyze-ticker-data-in-iceberg/README.md
  • 16-sling-data/README.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • 16-sling-data/README.md
  • 06-analyze-ticker-data-in-iceberg/README.md

📝 Walkthrough

Walkthrough

The 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.

Changes

Repository documentation

Layer / File(s) Summary
Repository overview and quick start
README.md
Adds repository-wide setup instructions, categorized examples, common project structure, execution guidance, and resource links.

Lakehouse and AI examples

Layer / File(s) Summary
Lakehouse and AI example guidance
05-write-ticker-data-to-iceberg/README.md, 06-analyze-ticker-data-in-iceberg/README.md, 11-trim-ticker-table/README.md, 13-ticker-update-agent/README.md
Updates descriptions for idempotent Iceberg ingestion, LLM analysis, retention enforcement, and an Iceberg-backed agent, including Tower catalog and sandbox setup details.

Orchestration and query examples

Layer / File(s) Summary
Parallel runs and DuckDB queries
08-fan-out-ticker-runs/README.md, 09-run-duckdb-queries-on-iceberg/README.md
Documents parallel Tower runs, synchronization, DuckDB Iceberg queries, required secrets, and deployment commands.

Additional demos

Layer / File(s) Summary
Notebook and Sling demos
15-interactive-marimo-notebook/README.md, 16-sling-data/README.md
Adds deployment instructions for the Marimo notebook and Sling-based JSON-to-Snowflake replication.

Cleanup

Layer / File(s) Summary
Obsolete configuration and sample data removal
.dlt/config.toml, 04-dlthub-data-pond/README.md, data/japan-trade-stats/.gitignore, data/ticker-data/*
Removes obsolete configuration, demo text, ignore rules, and bundled ticker datasets.

Poem

A rabbit hops through docs anew,
With Iceberg shelves and queries too.
Marimo spins, Sling tables gleam,
Parallel runs chase every dream,
While tidy data clears the queue.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: refining the examples repo with problem-first READMEs.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/tow-2417-tower-examples-fine-tuning-single-repo-cli-templates

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

📥 Commits

Reviewing files that changed from the base of the PR and between bc198bb and d7e5609.

⛔ Files ignored due to path filters (1)
  • data/fedres/FRB_G17.csv is excluded by !**/*.csv
📒 Files selected for processing (46)
  • .dlt/config.toml
  • 04-dlthub-data-pond/README.md
  • 05-write-ticker-data-to-iceberg/README.md
  • 06-analyze-ticker-data-in-iceberg/README.md
  • 08-fan-out-ticker-runs/README.md
  • 09-run-duckdb-queries-on-iceberg/README.md
  • 11-trim-ticker-table/README.md
  • 13-ticker-update-agent/README.md
  • 15-interactive-marimo-notebook/README.md
  • 16-sling-data/README.md
  • README.md
  • data/fedres/FRB_G17.csv.manualchange
  • data/fedres/FRB_G17_last10.csv.template
  • data/fedres/FRB_G17_last7.csv.template
  • data/japan-trade-stats/.gitignore
  • data/ticker-data/2025-03-18.json
  • data/ticker-data/2025-03-19.json
  • data/ticker-data/2025-03-20.json
  • data/ticker-data/2025-03-21.json
  • data/ticker-data/2025-03-22.json
  • data/ticker-data/2025-03-23.json
  • data/ticker-data/2025-03-24.json
  • data/ticker-data/2025-03-25.json
  • data/ticker-data/2025-03-26.json
  • data/ticker-data/2025-03-27.json
  • data/ticker-data/2025-03-28.json
  • data/ticker-data/2025-03-29.json
  • data/ticker-data/2025-03-30.json
  • data/ticker-data/2025-03-31.json
  • data/ticker-data/2025-04-01.json
  • data/ticker-data/2025-04-02.json
  • data/ticker-data/2025-04-03.json
  • data/ticker-data/2025-04-04.json
  • data/ticker-data/2025-04-05.json
  • data/ticker-data/2025-04-06.json
  • data/ticker-data/2025-04-07.json
  • data/ticker-data/2025-04-08.json
  • data/ticker-data/2025-04-09.json
  • data/ticker-data/2025-04-10.json
  • data/ticker-data/2025-04-11.json
  • data/ticker-data/2025-04-12.json
  • data/ticker-data/2025-04-13.json
  • data/ticker-data/2025-04-14.json
  • data/ticker-data/2025-04-15.json
  • data/ticker-data/2025-04-16.json
  • data/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

Comment thread 06-analyze-ticker-data-in-iceberg/README.md Outdated
Comment thread 16-sling-data/README.md
…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 bradhe left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Good improvements from my perspective!

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.

5 participants