docs: add architecture decision records page#350
Merged
Conversation
There was a problem hiding this comment.
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.mdwith 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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):
OutputKindat the forward siteValueError(Implement pluggable label-format adapters (COCO / YOLO / VOC ingestion) #338)Sourced from contributor docs, code comments, and accumulated design notes. Strict Sphinx build (
-n -W --keep-going) green.Checklist
Optional
🤖 Generated with Claude Code