Skip to content

Document the public API and CLI contract - #19

Merged
FU-max-boop merged 1 commit into
mainfrom
docs/api-cli-reference
Aug 16, 2026
Merged

FU-max-boop merged 1 commit into
mainfrom
docs/api-cli-reference

Conversation

@FU-max-boop

Copy link
Copy Markdown
Owner

Summary

  • add a documentation index and complete handwritten reference for the supported Python and advanced evidence APIs
  • document every CLI command, built-in scenario, exit code, and provider-free/network boundary
  • add drift tests that keep the 24 + 17 exports, 7 commands, 4 scenarios, and documentation entry points synchronized

Validation

  • 173 passed, 1 expected skip
  • Ruff check and format check
  • mypy src
  • package build and Twine strict checks
  • extracted minimal API example executed successfully and wrote a valid certificate

This changes documentation and drift coverage only; it does not change runtime behavior, schemas, CLI behavior, or public exports.

@FU-max-boop
FU-max-boop merged commit 186fda5 into main Aug 16, 2026
16 checks passed
@FU-max-boop
FU-max-boop deleted the docs/api-cli-reference branch August 16, 2026 22:33
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