Skip to content

docs: document complete invocation interface - #57

Merged
bateau84 merged 3 commits into
refactor/trusted-checkout-evidencefrom
docs/complete-invocation-usage
Oct 6, 2026
Merged

bateau84 merged 3 commits into
refactor/trusted-checkout-evidencefrom
docs/complete-invocation-usage

Conversation

@bateau84

@bateau84 bateau84 commented Oct 6, 2026

Copy link
Copy Markdown
Owner

Purpose

Close the remaining user-facing documentation gaps before PR #45 merges.

The runner is an isolated invocation execution boundary, not an eval-suite engine. This PR makes that contract explicit and documents every supported public invocation surface.

Changes

  • add docs/invocation-usage.md as the authoritative usage/interface reference;
  • explicitly state that there is no input-JSON request API today;
  • document the invocation input contract: CLI/Action arguments plus prompt/system/config seed files;
  • document all 24/24 CLI options, including defaults and transport applicability;
  • document all runner-specific environment overrides and recognized provider credentials;
  • document all 21/21 GitHub Action inputs and defaults;
  • document Action precedence: repository command mode, direct invocation mode, and setup-only mode;
  • document which CLI capabilities are not exposed as direct Action inputs;
  • add a complete "ways to run" matrix;
  • clarify that eval cases/assertions/judging remain owned by the calling harness;
  • correct the stale README description of the current zero-inference plugin activation preflight;
  • link the complete reference prominently from README local and Action usage sections.

Validation

Cross-checked the docs against the current implementation:

  • CLI flags documented: 24/24
  • Action inputs documented: 21/21
  • runner-specific environment overrides documented: 8/8

Documentation only; no runtime or contract behavior changes.

Targets refactor/trusted-checkout-evidence / PR #45.

@bateau84
bateau84 merged commit 2547810 into refactor/trusted-checkout-evidence Oct 6, 2026
1 check passed
@bateau84
bateau84 deleted the docs/complete-invocation-usage branch October 6, 2026 22:08
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.

1 participant