Repository navigation
Fold ADR-0001 into the architecture page - #6
Merged
Merged
Conversation
Architectural rationale lives in docs/architecture.md as a "Why ...?" section, not in a docs/adr/ tree. The S3 auth record moves there with its text unchanged apart from heading levels, so the credential-chain decision, the no-implicit-auth gate, the OIDC flow and the rejected alternatives all survive the move.
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The S3 implementation docstring still references the deleted ADR path.
Review effort: Balanced
Findings: 1
Open (1)
What changed in this PR
Moves ADR-0001 into the canonical architecture documentation.
Changes:
- Adds S3 authentication rationale to
docs/architecture.md. - Removes the standalone ADR file.
- Records the move in the changelog.
| File | Description |
|---|---|
docs/architecture.md |
Incorporates ADR-0001 content. |
docs/adr/0001-s3-auth-design.md |
Removes the former standalone ADR. |
CHANGELOG.md |
Documents the relocation. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+107
to
+109
| This section was ADR-0001 (`docs/adr/0001-s3-auth-design.md`), folded in here | ||
| because architectural rationale lives in this page rather than a separate ADR | ||
| tree. The text is unchanged apart from heading levels. |
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.
Moves the S3 auth design record (ADR-0001) out of
docs/adr/and intodocs/architecture.mdas a "Why S3 sync uses boto3's credential chain" section. Architectural rationale lives in the architecture page under the docs standard; there is nodocs/adr/tree.##→###,###→####). The credential-chain decision, the no-implicit-auth gate, the OIDC flow for CI, the S3-compatible endpoint support, the upload semantics, the rejected alternatives and the implementation sketch all come across.CHANGELOG.mdgains an Unreleased entry recording the move. The 0.7.0 entry that names the old path is left as written, since it is history.origin/main(the three Dependabot action bumps) is merged in.docs/SPEC.mdis unchanged by this PR.Checked locally:
ruff check src testsclean,mypy src/ai_config_kitclean,pytest296 passed. The 7test_fetch_*tests could not bind a local socket in the sandbox, so CI is the check for those.