Repository navigation
Add architecture decision records, starting with login - #28
Merged
Merged
Conversation
docs/adr/ records why Saman is built the way it is, next to the specification's own log of requirement changes. ADR-0001 writes down the login design from #21 and #23 (NF-02, NF-11, NF-12, NF-13) as accepted. ADR-0002 proposes limiting password login (NF-12) to named break-glass accounts, for discussion on this pull request. CLAUDE.md says when to write a record and that proposed ones aren't built. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Adds
docs/adr/for architecture decision records (ADRs): one file per technical decision, with its context, the options considered, the decision and its consequences.docs/specification/decisions.mdkeeps logging why requirements change. An ADR records how we build something.Contents
docs/adr/README.md: when to write a record, how (Proposed in a PR → Accepted or Rejected → implemented in its own PR), an index, and a template based on Michael Nygard's format plus an «Options» section.oid.Authorization: JWT.docs/adr/. It says accepted records are followed, proposed records are not built, and when to write a new one.Requirements: NF-02, NF-11, NF-12, NF-13. No specification changes. If ADR-0002 is accepted, NF-12 gets sharper wording in its own PR, with an entry in
decisions.md.The repository is public, so ADR-0002 describes the design and the trade-offs, but not how to exploit the current setup.
Outside this PR:
docs/diagrams/architecture.mdis out of date. It still says Entra ID sign-in is "decided but not built yet", and its diagram shows the OpenID Connect flow going to the frontend's pages, while ADR-0001 runs it in the CMS. I haven't touched it, since the SVG is drawn by hand from the Mermaid source.🤖 Generated with Claude Code