Skip to content

docs: add architecture decision records page#350

Merged
stanlrt merged 1 commit into
mainfrom
docs/architecture-decisions
Jul 6, 2026
Merged

docs: add architecture decision records page#350
stanlrt merged 1 commit into
mainfrom
docs/architecture-decisions

Conversation

@stanlrt

@stanlrt stanlrt commented Jul 6, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds docs/contributor/adr.md — a decision log of RAITAP's durable design choices, wired into the contributor toctree.

Ten records, each with the same fixed structure (Context / Options / Decision / Consequences):

Sourced from contributor docs, code comments, and accumulated design notes. Strict Sphinx build (-n -W --keep-going) green.

Checklist

  • CI — Required checks are green
  • Breaking changes — Not a breaking change; docs only.
  • Contributor guide — I've read Pull requests and commit messages before requesting review.

Optional

  • Docs (optional) — Adds a contributor ADR page.

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings July 6, 2026 15:05

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an Architecture Decision Records (ADR) page to the contributor documentation, capturing durable design choices and linking it into the contributor docs navigation.

Changes:

  • Added docs/contributor/adr.md with ten ADR entries using a consistent Context/Options/Decision/Consequences structure.
  • Wired the new ADR page into the contributor docs toctree (docs/contributor/index.md).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/contributor/index.md Adds adr to the contributor docs toctree so it appears in navigation/build.
docs/contributor/adr.md Introduces the ADR log page with structured records and cross-cutting principles.

@stanlrt stanlrt merged commit 7a11a8a into main Jul 6, 2026
17 of 18 checks passed
@stanlrt stanlrt deleted the docs/architecture-decisions branch July 6, 2026 21:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants