Skip to content

docs: document runtime global and deploy flags - #74

Merged
kstonekuan merged 1 commit into
Hebbian-Robotics:mainfrom
tasodoufu:docs/issue-72-runtime-flags
Aug 20, 2026
Merged

docs: document runtime global and deploy flags#74
kstonekuan merged 1 commit into
Hebbian-Robotics:mainfrom
tasodoufu:docs/issue-72-runtime-flags

Conversation

@tasodoufu

Copy link
Copy Markdown
Contributor

Summary

Document the global hflow flags and the deploy options that were recently added to the CLI reference.

Why

Resolves #72. Users can now find --version, -v/--verbose, deploy --output-dir, and deploy --requirements in docs/RUNTIME.md, with wording aligned to the current CLI help and behavior.

User impact

The runtime reference is more complete and no product behavior changes.

Validation

  • uv run python - <<'PY' ... (asserted all four option names are documented)
  • git diff --check
  • Markdown link check not run: lychee is not installed in the environment.

Unverified

The full lychee command from CONTRIBUTING.md was not run because the tool is unavailable locally.

@github-actions

Copy link
Copy Markdown

👋 Hi @tasodoufu — thank you so much for your first contribution to HFlow!

A maintainer will review your pull request as soon as possible. In the meantime:

💡 Tip: one open pull request per contributor at a time. Issues with an assignee are taken; everything else is fair game.

We are excited to have you here and appreciate your help making the project better! 🙌

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

Thank you @tasodoufu, and welcome! Clean first contribution: the wording matches the actual --help text, the placement is sensible, and the --requirements cross-reference to hflow up is exactly right.

What I validated locally:

  • Ran the full lychee link check from CONTRIBUTING.md on your branch (you noted it was unavailable in your environment): 230 links, 0 errors.
  • Verified the "must appear before the subcommand" claim against the real CLI: hflow -v status parses, hflow status -v exits 2. Nice catch documenting that; it is exactly the kind of detail argparse makes non-obvious.
  • Checked both deploy flag descriptions against src/hflow/cli.py; both match.

Merging now. If you would like another one, the open good first issues have plenty left (issues with an assignee are taken; everything else is fair game), and we hang out on Discord.

@kstonekuan
kstonekuan merged commit a624dad into Hebbian-Robotics:main Aug 20, 2026
5 checks passed
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.

Docs: RUNTIME.md misses the global --version/--verbose flags and two hflow deploy flags

2 participants