Skip to content

Docs: CATALOG.md never mentions curate --sql-file and lacks a catalog-root troubleshooting entry #71

Description

@kstonekuan

Two small gaps remain in docs/CATALOG.md: it does not explain a real
curate flag, and it has no troubleshooting entry for a common catalog-root
mistake.

Current behavior

curate --sql-file is undocumented

The positional SQL argument and --sql-file flag are defined at
src/hflow/cli.py:81-90. Passing both or neither prints
curate: pass exactly one of a SQL string or --sql-file and returns 2 at
src/hflow/cli.py:676-679.

The command-line example at docs/CATALOG.md:80-85 shows only inline SQL.
Meanwhile, examples/egocentric/README.md:79-83 uses --sql-file, so a reader
can encounter the flag in an example before the reference explains it.

Document --sql-file and the exactly-one rule in the command-line section of
docs/CATALOG.md.

The catalog-root error has no troubleshooting entry

src/hflow/curation.py:136-143 raises <location> is not a catalog root when
--catalog points at a data root instead of the catalog created beneath it.

Add a short troubleshooting entry explaining that the command expects the
catalog location, commonly <data_root>/catalog, rather than <data_root>.

Pattern to copy

Use the existing command-line block at docs/CATALOG.md:80-85 and the concise
troubleshooting style of the "Port 8080 is taken" entry at
docs/RUNTIME.md:407-412.

Definition of done

  • docs/CATALOG.md documents --sql-file and the exactly-one rule.
  • docs/CATALOG.md explains what is not a catalog root means and what path to
    pass instead.

Validation

lychee --no-progress --include-fragments \
  --exclude '^https://github\.com/Hebbian-Robotics/hflow/(issues|security/advisories/new)$' \
  --exclude-path references/mcap-spec.md \
  --exclude-path references/foxglove-CompressedVideo.proto .

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions