Skip to content

Entrypoints and Examples

Entrypoints and examples should make the contract around bijux-canon-ingest concrete quickly. A reader should be able to see one real way into prepared ingest behavior without reverse-engineering the package from source alone.

What To Check

  • name the entrypoints a reader is supposed to use first
  • tie examples to real commands, schemas, or artifacts instead of narrative placeholders
  • treat stale examples as contract bugs because they teach callers the wrong surface

First Proof Check

  • src and boundary-facing modules for the owning implementation surface
  • apis/bijux-canon-ingest/v1/schema.yaml or tracked examples for the documented contract surface
  • tests for executable confirmation that the contract still holds

Bottom Line

If callers depend on bijux-canon-ingest for prepared ingest behavior, the contract needs to be named as clearly as the implementation.