Skip to content

馃摑 Link the ADRs to the relevant SSW rules - #633

Merged
danielmackay merged 3 commits into
mainfrom
docs/link-adrs-to-ssw-rules
Jul 28, 2026
Merged

馃摑 Link the ADRs to the relevant SSW rules#633
danielmackay merged 3 commits into
mainfrom
docs/link-adrs-to-ssw-rules

Conversation

@danielmackay

Copy link
Copy Markdown
Member
  1. What triggered this change? (PBI link, Email Subject, conversation + reason, etc)

鉁忥笍 Follow-up to #630, which linked one ADR to its SSW rule. This does the same sweep across the rest of the log.

Reading all 17 ADRs against ssw.com.au/rules turned up 29 relevant rules that weren't referenced anywhere. It also turned up 10 gaps where the rules site either has nothing on the topic or is now out of date. Those gaps are tracked separately in the SAW backlog (SSWConsulting/SSW.SAW.General#39 through #48) and aren't touched here.

  1. What was changed?

鉁忥笍 Every ADR in docs/adr now points at the SSW rules behind its decision, following the shape already set by 20241118-produce-useful-sql-server-exceptions.md:

  • a one-line callout in ## Decision Outcome naming the most relevant rule
  • a ## Links section listing the rest

Three ADRs deliberately disagree with a published rule, and now say so instead of linking silently:

None of the decisions, options, or pros and cons were changed. Docs only, no code.

Verification: all 29 slugs were checked against the SSW.Rules.Content repo tree, and every URL returns HTTP 200 from ssw.com.au.

  1. Did you do pair or mob programming?

鉁忥笍 No, solo with Claude Code.

danielmackay and others added 3 commits July 28, 2026 10:54
Only the SQL exceptions ADR referenced ssw.com.au/rules. Reviewing all 17
against the rules site found 29 relevant rules that weren't linked anywhere.

Each ADR now names its most relevant rule inline in Decision Outcome and
lists the rest under Links, matching what #630 did for the SQL exceptions
ADR. Where an ADR disagrees with a published rule, it says so.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Code review on the previous commit found ten problems with the citations.

Two rules had been archived by SSW. Checking for HTTP 200 didn't catch it,
because archived rules still serve a 200 and only show a banner on the page.
Both now point at their live successors.

Three findings shared one cause: a paragraph of new reasoning about the
repository pattern added to an ADR accepted in 2023. The ADR log promises
its entries are immutable, so that paragraph is gone and the rule is left
as a plain entry under Links.

The rest were overstated or misread claims: the string-length rule relocates
constraints rather than dropping them, TypedResults checks the declared
codes rather than whether the code is the right one, the NSwag ADR cited a
rule that now leads with Scalar, and one rule title was truncated because
its YAML title spans two lines.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@danielmackay
danielmackay marked this pull request as ready for review July 28, 2026 01:56
@danielmackay
danielmackay merged commit e7418f9 into main Jul 28, 2026
2 checks passed
@danielmackay
danielmackay deleted the docs/link-adrs-to-ssw-rules branch July 28, 2026 01:59
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