Skip to content

Extensibility Model

Extension work should use the package seams that already exist instead of bypassing ownership.

This page is about where variation is welcomed and where it would be a design smell. A package becomes easier to extend when contributors can see which seams are meant to flex and which ones are carrying the core identity of the package.

Treat the architecture pages for bijux-canon-ingest as a reviewer-facing map of structure and flow. They should shorten code reading, not try to replace it.

Visual Summary

flowchart LR
    page["Extensibility Model<br/>clarifies: trace execution | spot dependency pressure | judge structural drift"]
    classDef page fill:#dbeafe,stroke:#1d4ed8,color:#1e3a8a,stroke-width:2px;
    classDef positive fill:#dcfce7,stroke:#16a34a,color:#14532d;
    classDef caution fill:#fee2e2,stroke:#dc2626,color:#7f1d1d;
    classDef anchor fill:#ede9fe,stroke:#7c3aed,color:#4c1d95;
    classDef action fill:#fef3c7,stroke:#d97706,color:#7c2d12;
    module1["retrieval-oriented models and assembly"]
    module1 --> page
    module2["package workflows"]
    module2 --> page
    module3["deterministic document transforms"]
    module3 --> page
    code1["src/bijux_canon_ingest/application"]
    page --> code1
    code2["src/bijux_canon_ingest/processing"]
    page --> code2
    code3["src/bijux_canon_ingest/retrieval"]
    page --> code3
    pressure1["tests/e2e for package boundary coverage"]
    pressure1 -.tests whether this structure still holds.-> page
    pressure2["tests/invariants for long-lived repository promises"]
    pressure2 -.tests whether this structure still holds.-> page
    pressure3["tests/unit for module-level behavior across processing, retrieval, and interfaces"]
    pressure3 -.tests whether this structure still holds.-> page
    class page page;
    class module1,module2,module3 positive;
    class code1,code2,code3 anchor;
    class pressure1,pressure2,pressure3 caution;

Likely Extension Areas

  • src/bijux_canon_ingest/processing for deterministic document transforms
  • src/bijux_canon_ingest/retrieval for retrieval-oriented models and assembly
  • src/bijux_canon_ingest/application for package workflows
  • src/bijux_canon_ingest/infra for local adapters and infrastructure helpers
  • src/bijux_canon_ingest/interfaces for CLI and HTTP boundaries
  • src/bijux_canon_ingest/safeguards for protective rules for ingest behavior

Extension Rule

Add extension points where the package already expects variation, and document them next to the owning boundary.

Concrete Anchors

  • src/bijux_canon_ingest/processing for deterministic document transforms
  • src/bijux_canon_ingest/retrieval for retrieval-oriented models and assembly
  • src/bijux_canon_ingest/application for package workflows

Use This Page When

  • you are tracing structure, execution flow, or dependency pressure
  • you need to understand how modules fit before refactoring
  • you are reviewing design drift rather than one isolated bug

Decision Rule

Use Extensibility Model to decide whether a structural change makes bijux-canon-ingest easier or harder to explain in terms of modules, dependency direction, and execution flow. If the change works only because the design becomes harder to read, the safer answer is redesign rather than acceptance.

What This Page Answers

  • how bijux-canon-ingest is organized internally in terms a reviewer can follow
  • which modules carry the main execution and dependency story
  • where structural drift would show up before it becomes expensive

Reviewer Lens

  • trace the described execution path through the named modules instead of trusting the diagram alone
  • look for dependency direction or layering that now contradicts the documented seam
  • verify that the structural risks named here still match the current code shape

Honesty Boundary

This page describes the current structural model of bijux-canon-ingest, but it does not guarantee that every import path or runtime path still obeys that model. Readers should treat it as a map that must stay aligned with code and tests, not as an authority above them.

Next Checks

  • move to interfaces when the review reaches a public or operator-facing seam
  • move to operations when the concern becomes repeatable runtime behavior
  • move to quality when you need proof that the documented structure is still protected

Purpose

This page helps maintainers extend the package without smearing responsibilities together.

Stability

Keep it aligned with the package seams that actually support extension today.