Skip to content

docs(cli): link runtime configuration from add help - #195

Merged
SearchSavior merged 1 commit into
SearchSavior:mainfrom
wsj040303:docs/runtime-config-help-link
Oct 13, 2026
Merged

SearchSavior merged 1 commit into
SearchSavior:mainfrom
wsj040303:docs/runtime-config-help-link

Conversation

@wsj040303

Copy link
Copy Markdown
Contributor

The openarc add --help runtime configuration option describes the JSON input but does not tell users where the advanced OpenVINO properties are documented.

Add the configuration reference URL to the existing option help, retaining the JSON example. A CLI test verifies the link is visible at both 80- and 160-column terminal widths.

Fixes #176.

Validation:

  • Actual CLI help reproduced the missing link before the change.
  • The two new help cases failed before the change and pass after it.
  • tests/unit/test_cli_runtime_config_help_unit.py and the related CLI/YAML/context tests: 49 passed in 0.22s.
  • The linked published configuration page and its runtime_config anchor were checked.
  • git diff --check: passed.

This change only updates help text; no model execution is needed. The full OpenVINO/model integration suite was not run.

@SearchSavior
SearchSavior merged commit 9adbb88 into SearchSavior:main Oct 13, 2026
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.

Add link to documentation for --runtime-config

2 participants