docs(skills): improve accuracy, structure, and consistency across CLI skills#172
Merged
Conversation
… skills A quality pass over all four agent skills, plus the recent-change updates (#170 unscoped indexes list incl. managed DBs; #167 KEDA cold-start note). Accuracy: - Drop the nonexistent `query status --output` flag (core + analytics). - Add `update` to the core top-level subcommand list. - Document `results list --limit` (default 100, max 1000) vs `queries list` (20). - Split `indexes list` (optional filters) from `indexes delete` (requires --connection-id + --schema + --table + --name). - Standardize `--catalog` as a catalog alias; fix Chain naming (uses --table/--catalog, not a --name flag); note embedding-providers create --output. Structure / progressive disclosure: - Reshape hotdata-geospatial (285 -> 166 lines): add the missing `hotdata query` execution layer + table-qualification/quoting note, sharpen the area-conversion caveat, and move the function catalog + unit tables to references/functions.md. - Slim core hotdata (373 -> 299 lines): collapse the ~5x-repeated context/DATAMODEL material into one section, de-bold prose, drop trailing workflow blocks already covered by references/WORKFLOWS.md. Consistency: - Unify context scoping language as database-scoped (was "workspace") across the core reference files. Verified all referenced commands/flags against the built CLI; all reference links resolve. Net ~184 fewer lines with higher accuracy and signal.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Reviewed against the CLI source in src/command.rs. All accuracy claims check out: query status has no --output flag, update is a real top-level subcommand, results list defaults to 100/max 1000 vs queries list 20, embedding-providers create has --output, indexes list filters are optional, and the #database-context-named-markdown anchor resolves. Clean docs quality pass.
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.
Summary
A quality pass over all four agent skills (
hotdata,hotdata-search,hotdata-analytics,hotdata-geospatial), driven by a per-skill audit and verified against the built CLI. Also folds in the recent-change doc updates: #170 (unscopedindexes listnow includes managed databases) and #167 (KEDA cold-start hint).Net ~184 fewer lines with higher accuracy and signal-to-noise.
Accuracy fixes (verified against
--help)query status --outputflag (core + analytics).updateto the core top-level subcommand list.results list --limit(default 100, max 1000) vsqueries list(20) — agents were likely under-fetching.indexes list(filters optional) fromindexes delete(requires--connection-id+--schema+--table+--name).--catalogas a catalog alias; fixed Chain naming (uses--table/--catalog, there is no chain-table--name); added the missingembedding-providers create --outputflag.Structure / progressive disclosure
hotdata queryexecution layer (the skill never showed how to run its SQL) + a table-qualification/quoting note, sharpened the area-conversion caveat (cos(latitude)shrink), and moved the function catalog + unit tables to a newreferences/functions.md.DATAMODELmaterial into one section, de-bolded prose, and dropped trailing "Workflow:" blocks already covered byreferences/WORKFLOWS.md.Consistency
#170 / #167 doc updates (carried in this branch)
indexes list(no flags) now spans regular connections and managed databases (shown under the internal__db_<id>.<schema>.<table>label); documented in search SKILL,INDEXES.md,MODEL_BUILD.md, and the data-model template.search --tableon a managed DB needs the SQL catalog prefix (default.public.<table>), not the__db_…label or a connection id.Verification
hotdatacommand referenced across the skills maps to a real subcommand.query,query status,databases load,indexes delete,embedding-providers create,results list).references/…links resolve to existing files.