Repository navigation
docs(readme): rework for users — quickstart first, tasks over flags - #207
Merged
Merged
Conversation
The README was a flag-by-flag reference manual with maintainer content mixed in. Restructured around what a new user does: install, a runnable quickstart (real public parquet, three commands to a query result), then task-oriented tours — getting data in (connect vs import, stated as a choice for the first time), query/explore, cross-source joins, search, scripting/agents. Per-flag detail defers to --help and the bundled skills; the Releasing section moves to docs/RELEASING.md; the version badge tracks releases instead of a hardcoded number.
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Verified all documented commands and flags against the CLI source (cli.rs, commands/auth.rs, databases.rs, connections.rs, ingest.rs) and env vars in config.rs/main.rs — everything matches. Quickstart's undeclared-table load path holds for a fresh database. Clean docs rework.
eddietejeda
added a commit
that referenced
this pull request
Jul 9, 2026
* chore(release): drop README version-badge replacement The README badge now tracks GitHub releases (#207), so the exactly=1 replacement would fail cargo-release. * chore: Release hotdata-cli version 0.13.0 --------- Co-authored-by: Eddie A Tejeda <669988+eddietejeda@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
The README read like an internal reference manual: every command documented flag-by-flag (duplicating
--helpand the bundled skills), release-process docs for maintainers, and changelog-style notes about removed flags. A new user had no runnable path from install to a query result.What
--url— verified live).attach, search (index → search in two commands), and a scripts-and-agents section (-o json, exit codes,databases run,skills install,context).--helpfor flags.docs/RELEASING.md; the version badge now tracks GitHub releases instead of a hardcoded number.buckets,api) and keep secrets out of argv.148 insertions, 282 deletions — net −134 lines.
Verification
All referenced commands checked against the built binary (
auth register,completions,databases run, ingest verbs); quickstart URL returns 200.