Skip to content

docs(decisions): record the decision, not the mechanism (#334 item 1 + mechanism sweep) - #344

Closed
onemen wants to merge 1 commit into
mainfrom
docs/dedupe-334-item1
Closed

onemen wants to merge 1 commit into
mainfrom
docs/dedupe-334-item1

Conversation

@onemen

@onemen onemen commented Sep 27, 2026

Copy link
Copy Markdown
Owner

What

Item 1 — template rule: docs/decisions/0000-template.md gains the one-line rule in its Decision section: record the decision, not the mechanism — write the invariant and boundary condition, not the APIs that implement it today. Future records stop re-accumulating identifiers like the ones ADR 0012 had collected (b.addTrustedTab, nsITimer, skippedHash.* — trimmed in 5133f84).

Item 2 — sweep of the worst accumulators (verified by grepping all 36 records for mechanism identifiers; the names already live in docs/auto-updater.md / docs/DEVELOPING.md / AGENTS.md / code — nothing is lost):

  • 0011: helper invocation mechanics out (binary names, runas/pkexec/osascript, Subprocess.call, exit-code mapping, IOUtils/commit refs) → decision kept (standalone per-OS helper, fresh download, one elevation, distinct cancel exit code, direct-copy-first) + pointer to docs/auto-updater.md.
  • 0019: self-update section drops the managed-block JSON field names (installerDate, download-map shape) and the BUILD_DATE conf key name; notes Move the installer self-update block out of installer-<date> release bodies to gh-pages (post-v1.0) #341 as the mechanism's future home. Decision intact: date-based detection, body ingestion via /releases, silent-when-absent.
  • 0026: the STABLE_HASHES_URL/STABLE_ZIP_BASE_URL/STABLE_UI_BASE_URL/STABLE_HELPER_BASE_URL list becomes "a set of stable-channel fallback URLs, generated from config/installer.conf per [0013]"; key names live in docs/DEVELOPING.md (+ auto-updater.md:160 keeps the STABLE_* mention).

Candidates checked and left as-is: 0005 (no transport APIs — clean), 0024/0027/0030/0031/0035/0036/0013/0016/0007/0003/0006/0032 (asset names / file names are the subject of those decisions — e.g. 0024 defines the asset set by name, 0035 defines the sidecar-naming rule; removing them would gut the decision).

Validation

  • pnpm check:decisions ✓ (36 records, links/statuses/amendments OK)
  • pnpm format (markdownlint) ✓ · no code touched

Part of #334. Items 3–5 (future-work.md retirement, AGENTS.md pointers, roadmap.md decision) stay open as their own PRs.

🤖 Generated with Codebuff
Co-Authored-By: Codebuff noreply@codebuff.com

… + sweep)

Item 1: 0000-template gains the rule — write the invariant and boundary
condition, not the APIs that implement it today; implementation detail
lives in docs/ and code comments.

Sweep of the worst mechanism accumulators, keeping decision + invariant +
provenance:
- 0011: helper invocation detail (binary names, runas/pkexec/osascript,
  Subprocess.call, exit-code mapping) → pointer to docs/auto-updater.md.
- 0019: the self-update section drops the managed-block JSON field names
  and BUILD_DATE conf name; #341 noted as the mechanism's future home.
- 0026: the STABLE_* generated-key list becomes "baked fallback URLs,
  generated from installer.conf per 0013" (names live in DEVELOPING.md).

No decision changes — the records decide the same things they decided
before; only the mechanism duplication is gone.

Part of #334 (each item lands as its own PR).

🤖 Generated with Codebuff
Co-Authored-By: Codebuff <noreply@codebuff.com>
@onemen

onemen commented Sep 28, 2026

Copy link
Copy Markdown
Owner Author

Superseded by #357, which carries this PR's commits unchanged (fresh branch off main @ f01043f, cherry-picked as agreed in #334 — no rebase, no re-triggered CI). This PR stays closed; review the content on #357.

🤖 Closed as superseded by the Codebuff agent (Buffy) per the maintainer's #334 instruction to consolidate the doc work in one fresh PR.

@onemen onemen closed this Sep 28, 2026
@onemen
onemen deleted the docs/dedupe-334-item1 branch September 28, 2026 18:39
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.

1 participant