docs: collapse single-file docs/adrs into docs/rfcs#307
Merged
Conversation
The docs/adrs/ taxonomy held one file (ADR-0001 — metrics-sourced pattern inputs). A one-file decision-record directory is taxonomy drift parallel to docs/rfcs/ (13 RFCs + README + template). ADR-0001's content is load-bearing (active design for issue #260 PR-B, referenced from 4 doc files + 5 source-code comments) so it's promoted to RFC-0014 verbatim with the RFC template's section headings. References across docs/ and module/ are repointed at RFC-0014. The docs/adrs/ directory is removed. Signed-off-by: Tri Lam <tri@maydow.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.
Summary
The
docs/adrs/directory held one file (0001-metrics-to-logs-pattern-input.md). A single-file decision-record directory sitting parallel todocs/rfcs/(13 RFCs + README + template) is taxonomy drift — operators and contributors had to learn two near-identical conventions for "load-bearing architectural decision in tree."This PR collapses the split.
What changed
docs/rfcs/0014-metrics-to-logs-pattern-input.md). Content reformatted to match the RFC template's section headings (Summary / Motivation / Proposal / Alternatives / Open questions / Migration / References). The substance (Option A vs Option B vs Option C analysis, the v0.130 contrib survey, PR-A landed + PR-B pending sequencing) is preserved verbatim — this is active design for issue Recipe extension: emit hw.gpu.nvlink.* + wire metrics path for pattern-1 detector #260 PR-B, not archaeology.docs/adrs/directory removed.docs/README.md(subdirectories table —adrs/row removed)docs/ATTRIBUTES.md(2 spots:tracecore.alert.pcie_rate_collapse.*row + "See also" link)docs/integrations/prometheus-scrape.md(2 spots)docs/patterns/pattern-4-thermal-throttle.mddocs/patterns/pattern-5-pcie-aer.mdmodule/processor/patterndetectorprocessor/{patterndetector.go,thermal_throttle_test.go},module/pkg/patterns/{pcie_aer.go,thermal_throttle.go}).docs/rfcs/README.mdstatus-index gains an RFC-0014 row (accepted, 2026-05-31).Why convert (not delete)
ADR-0001 was evaluated against the "delete if RFC-0013 already covers it" bias. It is not covered:
metricthresholdconnectoras a contribution slot in one bullet. It does not evaluate Option A vs Option B vs Option C, cite the contrib v0.130 evidence, or sequence the PR-A/PR-B split for the metric-sourced detectors.pcie_aer.go,thermal_throttle.go,patterndetector.go) cites it as the reason for the staged-but-quiet wire-up.Delete would orphan 5 source comments and break the audit trail for an active design decision. Convert keeps the record load-bearing without preserving the parallel taxonomy.
Verification
grep -rn "docs/adrs\|adrs/0001"returns 0 hits.grep -rn "ADR-0001\|ADR 0001"returns 0 hits.ls docs/ | grep -i adrreturns empty.Test plan
grep -rn "docs/adrs"returns 0 hitsgrep -rn "ADR-0001"returns 0 hitsdocs/adrs/directory removed