Skip to content

Contracts

Discovery Contract

  • This repo should expose agent-readable context through docs/agent and docs/context.
  • Repo-local manifest and start-here guidance are authoritative when present.

Documentation Contract

  • docs/index.md is the human-facing entrypoint for the documentation set.
  • Canonical content should be edited in the most specific source page rather than patched indirectly through summaries.
  • Repo-local context files should stay concise and operational; architecture or business policy belongs in the main docs tree.
  • Treat this repo as developer guidance for ABS implementation, not as the primary operations handbook.

Model And Diagram Contract

  • When a workflow, actor label, or system term changes, update both the markdown explanation and the referenced diagram source.
  • Prefer editing .puml sources rather than only touching rendered image outputs.
  • BSS and Odoo integration terminology should stay aligned with related DIRAC repos when cross-repo terminology decisions have already been made.
  • Use PA as the current portal-app language. Treat OVApp as legacy wording unless historical reference is required.
  • Use service model for runtime ABS behavior. Reserve service template for commercial packaging in emob-commercial-models.
  • Treat Odoo business transactions as the entitlement and pricing source of truth. ABS enforces and substantiates entitlement through physical and IoT operations.
  • Do not introduce a separate ABS-owned asset affiliation model while Odoo-side asset anchoring is based on stock and inventory constructs.
  • Keep the system split explicit:
  • dirac-abs owns ABS asset, bundle, entitlement, and IoT/device behavior.
  • dirac-odoo owns Odoo ERP-side transaction, inventory, sales, and people semantics.
  • emob-commercial-models owns operations-facing commercial framing and SOP guidance built on top of both systems.
  • Treat docs/reference/repo-boundaries.md as the stable reader-facing summary of that split.
  • If repos disagree:
  • emob-commercial-models wins on functional intent
  • dirac-odoo wins on Odoo implementation
  • dirac-abs wins on ABS implementation

Build Contract

  • Root mkdocs.yml is the MkDocs entrypoint for local builds.
  • Generated site/ output is not source of truth and should not be committed as authored content.