docs(adr): compress to 3 records in the domain-modeling format - #106
Merged
Merged
Conversation
Rewrite each record as a title plus one paragraph, dropping the **Decision:** lead and the **Revisit trigger:** footer. No record was dropped or merged: all three pass the admission test, so the numbering and every citation are unchanged. - 0001: fold the templates-reuse-the-chevron rule and the ALLOWED_COLORS gate into the paragraph; record the pytest bars' gold ramp as the one sanctioned exception to the single-gold inner. - 0002: keep the empty-room threshold as the load-bearing reason, fold the borrow-audiences principle and the conditional backlink into one clause, and drop the reference to a tracking issue that no longer resolves. - 0003: fold the redraw cost into the paragraph as the boundary of the decision.
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.
Rewrites
docs/adr/from 3 records (839 words) to 3 (459 words), one paragraph each, in the shapedocs/standard.mdasks for. This repo owns that sentence, so its own records should read like it. Same treatment as modern-python/compose2pod#102.Nothing was dropped or merged: all three records pass the admission test, so the numbering is untouched and no citation moves. The compression is in the prose and the format, the
**Decision:**lead and the**Revisit trigger:**footer are gone, with a trigger folded into the paragraph only where it is the real boundary of the decision.Evaluation
The rules that survived from the sections that were cut, rather than being lost with them: the two templates reuse the org chevron (0001),
ALLOWED_COLORSis where the colour rule is enforced (0001), and one org-wide room per platform, never per-repo, if rooms ever open (0002).Citations
None moved.
tests/test_projects.py(0001),CONTEXT.md(0002),brand/build/symbols.py(0003) anddocs/agents/domain.md(ADR-0001plus the file tree) all cite names that are unchanged. The repo-wide sweep finds no reference to a number that no longer exists.mkdocs.ymlexcludes/adr/from the published site, so these files render on GitHub only; nothing here adds a link that would have to resolve in both renderings.Stale claims corrected
projects.py::ALLOWED_COLORSadmitssymbols._BAR_TINTS, the pytest bars' four-step gold ramp, which the code calls "the one allowed non-token palette". The record now names it as the one sanctioned exception.modern-python/.github#58for launch week. That number resolves to neither an issue nor a PR today, so the bare reference is dropped and launch week is stated as the boundary instead.FLASK_PATHSinsymbols.py; the scope claim (FastStream's mark and Flask's horn are the only literal partner paths) was re-checked againstsymbols.pyand holds.Gates
pytest -q tests/test_adr_citations.pypytest -qlychee --offlineover the three records,CONTEXT.md,AGENTS.mdmkdocs build --strictdocs/adr/stays out of the site, asexclude_docsintendsjusthastestandsync-assetsonly