Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ADR 001: Adopt ODW sidecar launches for Codex-oriented df12-build runs
# Architectural decision record (ADR) 0001: Adopt ODW sidecar launches for Codex-oriented df12-build runs

## Status

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ADR 002: Assess partial task branches before fresh restart
# Architectural decision record (ADR) 0002: Assess partial task branches before fresh restart

## Status

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Architectural decision record (ADR) 003: correlation-first OpenTelemetry observability for workshop runs
# Architectural decision record (ADR) 0003: Correlation-first OpenTelemetry observability for workshop runs

## Status

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Architectural decision record (ADR) 004: Oxlint rules for ODW source
# Architectural decision record (ADR) 0004: Oxlint rules for ODW source

## Status

Expand Down Expand Up @@ -34,7 +34,7 @@ artefacts as if they were authored source.
## Decision outcome

`make lint` runs Oxlint against `src/` using
[`oxlint.config.mjs`](../oxlint.config.mjs). The configuration enables the
[`oxlint.config.mjs`](../../oxlint.config.mjs). The configuration enables the
Unicorn plug-in rules supported by the pinned Oxlint release, imports the
recommended `ai-deslop` rules, enables type-aware linting, and turns the other
Oxlint categories off. It excludes `workflows/**`. Tests remain outside this
Expand Down
13 changes: 7 additions & 6 deletions docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ handoff mechanism.
The workflow follows this high-level sequence:

- Run fresh-run recovery when `resumePartialBranches=true`: discover surviving
`roadmap-*` branches from durable Git state, assess them through the ADR 002
`roadmap-*` branches from durable Git state, assess them through the ADR 0002
contract, and either report them (assess mode) or route eligible clean
`adopt-complete` branches into the ordinary review and integration path
(review mode). Discovered ids are held out of normal selection for the rest
Expand Down Expand Up @@ -289,11 +289,12 @@ The sidecar contract is documented at three levels:
external services, prompt-injection surface, and sandbox profiles.
- `docs/developers-guide.md` explains how contributors change the workflow and
keep documentation synchronized.
- `docs/adr-001-adopt-odw-sidecar-launches.md` records the architectural
decision to use ODW sidecar launches for Codex- and Claude-oriented runs.
- `docs/adr-002-assess-partial-task-branches.md` records the accepted
assessment stage for preserving useful partial task branches without resuming
transient agent transcripts.
- `docs/adrs/adr-0001-adopt-odw-sidecar-launches-for-codex-oriented-df12-build-runs.md`
records the architectural decision to use ODW sidecar launches for Codex- and
Claude-oriented runs.
- `docs/adrs/adr-0002-assess-partial-task-branches-before-fresh-restart.md`
records the accepted assessment stage for preserving useful partial task
branches without resuming transient agent transcripts.

Changes to launch behaviour, sidecar artefacts, configuration arguments, or
agent-routing defaults must update all affected layers in the same branch.
Expand Down
16 changes: 8 additions & 8 deletions docs/contents.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,24 +42,24 @@ workflow assets, or understanding why the system is shaped the way it is.

## Decision records

- [ADR 001: Adopt ODW sidecar launches](adr-001-adopt-odw-sidecar-launches.md):
- [ADR 0001: Adopt ODW sidecar launches](adrs/adr-0001-adopt-odw-sidecar-launches-for-codex-oriented-df12-build-runs.md):
records the decision to launch Codex-oriented runs from a sidecar directory.
- [ADR 002: Assess partial task branches](adr-002-assess-partial-task-branches.md):
- [ADR 0002: Assess partial task branches](adrs/adr-0002-assess-partial-task-branches-before-fresh-restart.md):
records the decision to assess surviving task branches before a fresh restart.
- [ADR 003: Correlation-first OpenTelemetry observability](adr-003-opentelemetry-observability.md):
- [ADR 0003: Correlation-first OpenTelemetry observability](adrs/adr-0003-correlation-first-opentelemetry-observability-for-workshop-runs.md):
records the accepted decision to correlate workflow nodes and agent telemetry
through dispatch-time identity, a local OTLP collector, and a SQLite store.
- [ADR 004: Oxlint source rules](adr-004-linting-strategy.md): records the
pinned Unicorn and deslop profiles for authored ODW source and the workflow
artefact exclusion.
- [ADR 0004: Oxlint source rules](adrs/adr-0004-oxlint-rules-for-odw-source.md):
records the pinned Unicorn and deslop profiles for authored ODW source and
the workflow artefact exclusion.

## Plans

- [Execution plans](execplans/): self-contained execution plans for larger
pieces of work.
- [ADR 002 partial task branch assessment](execplans/adr-002-partial-task-branch-assessment.md):
- [ADR 0002 partial task branch assessment](execplans/adr-002-partial-task-branch-assessment.md):
the plan behind the partial-branch assessment behaviour.
- [ODW compilation](execplans/odw-compilation.md): the plan behind the
compile-time testing and artefact build.
- [Workflow observability contract (5.1.1)](execplans/5-1-1-otel-support.md):
the plan for defining the identity and schema contract behind ADR 003.
the plan for defining the identity and schema contract behind ADR 0003.
29 changes: 15 additions & 14 deletions docs/developers-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ Read these before changing launch or workflow behaviour:
boundaries.
- `docs/security-and-permissions.md` for runtime permissions, external service
access, prompt-injection risk, and sandbox recommendations.
- `docs/adr-001-adopt-odw-sidecar-launches.md` for the accepted sidecar launch
decision.
- `docs/adr-002-assess-partial-task-branches.md` for the accepted partial
branch assessment and adoption model.
- `docs/adr-003-opentelemetry-observability.md` for the accepted
correlation-first observability fabric, and
- `docs/adrs/adr-0001-adopt-odw-sidecar-launches-for-codex-oriented-df12-build-runs.md`
for the accepted sidecar launch decision.
- `docs/adrs/adr-0002-assess-partial-task-branches-before-fresh-restart.md` for
the accepted partial branch assessment and adoption model.
- `docs/adrs/adr-0003-correlation-first-opentelemetry-observability-for-workshop-runs.md`
for the accepted correlation-first observability fabric, and
`docs/workflow-observability-contract.md` for the version-1 identity model,
attribute registry, envelope, and binding schemas that later steps build
against.
Expand Down Expand Up @@ -86,13 +86,14 @@ Relevant paths:
- `docs/security-and-permissions.md`: runtime permissions and sandbox guide.
- `docs/developers-guide.md`: contributor-facing maintenance guide.
- `docs/architecture.md`: design-level sidecar and workflow contract.
- `docs/adr-001-adopt-odw-sidecar-launches.md`: accepted launch decision.
- `docs/adr-002-assess-partial-task-branches.md`: accepted recovery assessment
decision.
- `docs/adr-003-opentelemetry-observability.md`: accepted observability
decision, with `docs/workflow-observability-contract.md` and
`schemas/observability/` as its normative contract and machine-readable
schemas.
- `docs/adrs/adr-0001-adopt-odw-sidecar-launches-for-codex-oriented-df12-build-runs.md`:
accepted launch decision.
- `docs/adrs/adr-0002-assess-partial-task-branches-before-fresh-restart.md`:
accepted recovery assessment decision.
- `docs/adrs/adr-0003-correlation-first-opentelemetry-observability-for-workshop-runs.md`:
accepted observability decision, with
`docs/workflow-observability-contract.md` and `schemas/observability/` as its
normative contract and machine-readable schemas.

Tick the matching roadmap task and update the relevant ExecPlan whenever a
branch lands planned work.
Expand Down Expand Up @@ -790,7 +791,7 @@ what stops `make all`'s lenient verification quietly skipping in CI.
`oxlint.config.mjs` applies the supported Unicorn recommended rules and the
recommended `ai-deslop` rules with type-aware checks. Its exact dependency
pins, the Unicorn/deslop rule conflict, and scoped ODW rule exceptions are
recorded in `docs/adr-004-linting-strategy.md`.
recorded in `docs/adrs/adr-0004-oxlint-rules-for-odw-source.md`.

The workflow artefacts in `workflows/` are excluded from Oxlint. They are
object code: `make workflow-parse` checks their workflow syntax and
Expand Down
Loading
Loading