Operations¶
This section explains how to install, run, diagnose, and release bijux-canon-agent from checked-in workflow guidance instead of team memory.
These pages are the checked-in operating memory for bijux-canon-agent. They should let a maintainer move from setup to diagnosis to release without relying on CI archaeology or private habits.
Treat the operations pages for bijux-canon-agent as the package's explicit operating memory. They should make common tasks repeatable without relearning the workflow from logs or oral history.
Visual Summary¶
flowchart RL
page["Operations<br/>clarifies: repeat workflows | find diagnostics | release safely"]
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;
step1["operator configuration under src/bijux_canon_agent/config"]
step1 --> page
step2["packages/bijux-canon-agent/pyproject.toml"]
step2 --> page
step3["CLI entrypoint in src/bijux_canon_agent/interfaces/cli/entrypoint.py"]
step3 --> page
run1["tests/invariants for package promises that should not drift"]
page --> run1
run2["tests/unit for local behavior and utility coverage"]
page --> run2
run3["tests/integration and tests/e2e for end-to-end workflow behavior"]
page --> run3
release1["pyproject.toml"]
run1 --> release1
release2["README.md"]
run2 --> release2
release3["CHANGELOG.md"]
run3 --> release3
class page page;
class step1,step2,step3 positive;
class run1,run2,run3 anchor;
class release1,release2,release3 action;
Pages in This Section¶
- Installation and Setup
- Local Development
- Common Workflows
- Observability and Diagnostics
- Performance and Scaling
- Failure Recovery
- Release and Versioning
- Security and Safety
- Deployment Boundaries
Read Across the Package¶
- Foundation when you need the package boundary and ownership story first
- Architecture when the question becomes structural, modular, or execution-oriented
- Interfaces when the question becomes caller-facing, schema-facing, or contract-facing
- Quality when the question becomes proof, risk, trust, or review sufficiency
Concrete Anchors¶
packages/bijux-canon-agent/pyproject.tomlfor package metadatapackages/bijux-canon-agent/README.mdfor local package framingpackages/bijux-canon-agent/testsfor executable operational backstops
Use This Page When¶
- you are installing, running, diagnosing, or releasing the package
- you need repeatable operational anchors rather than architectural framing
- you are responding to package behavior in local work, CI, or incident pressure
Decision Rule¶
Use Operations to decide whether a maintainer can repeat the package workflow from checked-in assets instead of memory. If a step works only because someone already knows the trick, the workflow is not documented clearly enough yet.
What This Page Answers¶
- how
bijux-canon-agentis installed, run, diagnosed, and released in practice - which checked-in files and tests anchor the operational story
- where a maintainer should look first when the package behaves differently
Reviewer Lens¶
- verify that setup, workflow, and release statements still match package metadata and current commands
- check that operational guidance still points at real diagnostics and validation paths
- confirm that maintainer advice still works under current local and CI expectations
Honesty Boundary¶
This page explains how bijux-canon-agent is expected to be operated, but it does not replace package metadata, actual runtime behavior, or validation in a real environment. A workflow is only trustworthy if a maintainer can still repeat it from the checked-in assets named here.
Next Checks¶
- move to interfaces when the operational path depends on a specific surface contract
- move to quality when the question becomes whether the workflow is sufficiently proven
- move back to architecture when operational complexity suggests a structural problem
Purpose¶
This page explains how to use the operations section for bijux-canon-agent without repeating the detail that belongs on the topic pages beneath it.
Stability¶
This page is part of the canonical package docs spine. Keep it aligned with the current package boundary and the topic pages in this section.