[leynos]

Summary

This branch imports the latest df12 Productions documentation style guide and
applies its four-digit, title-derived naming scheme to all four ADRs. It moves
the records into the canonical directory, updates their headings and references
across the contents index, roadmap, design documents, ExecPlans, supervisor
skill, tests, and workflow prompts, and regenerates the ODW artefact. No RFC
files exist in this repository, so the guide's RFC scheme applies to future
records.

This PR is stacked on PR #85,
which carries the unrelated generated spelling-rule refresh required by the
repository gate.

Review walkthrough

• The imported conventions appear in
  docs/documentation-style-guide.md.
• The renamed entries and cross-references are visible in
  docs/contents.md,
  docs/roadmap.md,
  and docs/architecture.md.
• The renamed records and ExecPlan references appear in
  ADR 0001
  and the observability ExecPlan.
• ADR discovery and the assessment link are updated in
  ODW config,
  assessment prompts,
  the generated ODW artefact,
  and the Claude Code workflow.

Validation

• make workflow-build: passed.
• make fmt: passed.
• make all: all required gates passed sequentially, including tests, workflow
  freshness, and module verification.
• Relative Markdown link targets and git diff --check: passed.

References

• Upstream documentation style guide.
• Base spelling-rules PR #85.
• Lody session.

Summary by Sourcery

Adopt the latest documentation conventions and standardize ADR storage and naming across the repository.

Enhancements:

• Adopt the latest documentation style guide, including expanded guidance for migration guides, user and developer documentation, RFCs, ADRs, repository layout, accessibility, and tested examples.
• Rename and relocate all four ADRs using four-digit, title-derived filenames and update their headings and repository-wide references.
• Update workflow configuration, assessment prompts, tests, skills, and generated workflow artefacts to discover and reference ADRs from the canonical directory.

Documentation:

• Synchronize documentation indexes, architecture and design documents, roadmaps, ExecPlans, and guides with the new ADR naming scheme and style conventions.

[coderabbitai]

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

• Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true

CodeRabbit Verify

• Run CodeRabbit Verify to test the changes in this pull request.

[sourcery-ai]

Reviewer's Guide

This PR imports the current documentation conventions, moves all four ADRs into the canonical four-digit title-slug layout, and propagates the new paths and identifiers through documentation, workflow discovery and prompts, generated artefacts, tests, and supporting fixtures.

Flow diagram for the ADR naming migration

flowchart TD
    Old["Legacy ADR files under docs/"] --> Guide["Documentation style guide"]
    Guide --> Rename["Four-digit title-derived names"]
    Rename --> Move["Move records to docs/adrs/"]
    Move --> References["Update links, prompts, tests, and fixtures"]
    References --> Regenerate["Regenerate ODW artefact"]
    Regenerate --> Validate["Run formatting, tests, and workflow gates"]

Loading

File-Level Changes

Change	Details	Files
Imports the latest documentation style guide and expands repository-wide authoring conventions.	Adds updated spelling, heading, linking, migration-guide, tested-example, developer-guide, RFC, ADR, repository-layout, and Rust documentation rules. Preserves the upstream guide’s canonical templates and naming requirements.	docs/documentation-style-guide.md
Renames all existing ADRs to the canonical four-digit, title-derived layout and updates their headings and internal links.	Moves four records into docs/adrs/ using adr-nnnn-title-slug.md filenames. Changes ADR headings to four-digit identifiers and updates the moved ADR’s relative repository link. Replaces ADR references throughout indexes, design documents, roadmap, guides, ExecPlans, skills, and tests.	docs/adr-001-adopt-odw-sidecar-launches.md docs/adr-002-assess-partial-task-branches.md docs/adr-003-opentelemetry-observability.md docs/adr-004-linting-strategy.md docs/architecture.md docs/contents.md docs/developers-guide.md docs/execplans/5-1-1-otel-support.md docs/execplans/adr-002-partial-task-branch-assessment.md docs/failure-resume-design.md docs/roadmap.md docs/users-guide.md docs/workflow-observability-contract.md
Updates workflow configuration, generated workflow output, and agent prompts to discover ADRs from the new canonical directory.	Changes default ADR discovery from docs/adr-*.md to docs/adrs/*.md. Updates assessment prompts and comments to reference ADR 0002 and its new path. Regenerates the ODW workflow artefact and updates the Claude Code workflow prompt.	src/workflows/df12-build-odw/assessment.ts src/workflows/df12-build-odw/config.ts src/workflows/df12-build-odw/main.ts src/workflows/df12-build-odw/run-task.ts src/workflows/df12-build-odw/schemas.ts workflows/df12-build-odw.js workflows/df12-build.js
Synchronizes tests and fixtures with the renamed ADR contract and validates the generated/documentation changes through repository gates.	Renames ADR references in assessment, recovery, schema, module, prompt, and fixture tests. Confirms workflow build, formatting, full gates, link targets, and whitespace checks pass.	tests/df12-build-odw-assessment.test.mjs tests/df12-build-odw-recovery.test.mjs tests/fixtures/prompts/recovery-resume-code-review.txt tests/fixtures/prompts/recovery-resume-expert-review.txt tests/fixtures/prompts/recovery-resume-integrate.txt tests/fixtures/recovery-mock-agent.mjs tests/fixtures/recovery-repo.mjs tests/fixtures/run-odw-simulation.mjs tests/modules/assessment.test.ts tests/modules/schemas.test.ts

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.