Skip to content

docs: improve README for developer experience#3

Merged
eddietejeda merged 2 commits into
mainfrom
docs/readme-improvements
May 25, 2026
Merged

docs: improve README for developer experience#3
eddietejeda merged 2 commits into
mainfrom
docs/readme-improvements

Conversation

@eddietejeda
Copy link
Copy Markdown
Contributor

Rewrites the README from a developer experience perspective:

  • Opens with a one-line value proposition instead of an internal feature list
  • Install and authentication up front
  • Quickstart block you can copy-paste and run immediately
  • Dedicated sections for each main use case with working code snippets
  • Covers scoping SQL to a managed database and controlling result size
  • Links to runnable examples

@eddietejeda eddietejeda force-pushed the docs/readme-improvements branch from a44b4ab to 10a0eb5 Compare May 25, 2026 02:07
Comment thread README.md
Comment on lines 49 to 53
tools["hotdata_create_managed_database"].call(
name="sales",
schema_name="public",
tables="orders",
tables="orders,customers",
)
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The tables argument is parsed with splitlines() (see hotdata_llamaindex/tools.py:62), not by commas. Passing tables="orders,customers" will create a single table literally named orders,customers rather than two tables.

The existing examples/llamaindex_managed_db.py uses the correct form ("orders\ncustomers"), and the function's docstring also says "one per line". Please update the snippet to match — otherwise users copy-pasting from the README will produce broken managed databases.

Suggested change
tools["hotdata_create_managed_database"].call(
name="sales",
schema_name="public",
tables="orders",
tables="orders,customers",
)
tools["hotdata_create_managed_database"].call(
name="sales",
schema_name="public",
tables="orders\ncustomers",
)

Copy link
Copy Markdown

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

Review

Blocking Issues

  • README.md lines 49–53: the hotdata_create_managed_database example uses tables="orders,customers", but the tool parses tables with splitlines() (hotdata_llamaindex/tools.py:62). The comma-separated form creates a single table named orders,customers instead of two tables.

Action Required

Change the example to use a newline-separated string ("orders\ncustomers"), matching examples/llamaindex_managed_db.py and the docstring ("one per line").

Copy link
Copy Markdown

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

Prior feedback on the tables argument is resolved — the snippet now uses tables="orders\ncustomers", matching tools.py:62's splitlines() parsing.

@eddietejeda eddietejeda merged commit 28bbb99 into main May 25, 2026
2 checks passed
@eddietejeda eddietejeda deleted the docs/readme-improvements branch May 25, 2026 02:12
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.

1 participant