Skip to content

docs(issues): [#2264] [#2278] record the discussion outcomes from PR #2428 - #2434

Merged
josecelano merged 9 commits into
torrust:developfrom
da2ce7:2264-2278-record-discussion-outcomes
Oct 10, 2026
Merged

josecelano merged 9 commits into
torrust:developfrom
da2ce7:2264-2278-record-discussion-outcomes

Conversation

@da2ce7

@da2ce7 da2ce7 commented Oct 4, 2026 •

Copy link
Copy Markdown
Contributor

Related to #2264
Related to #2278

Summary

PR #2428 merged three design discussions under docs/discussions/2003-overhaul-guardrails-and-automation/, each ending in an Outcome section that transcribes the EPIC owner's answers and notes that none of them is recorded in an EPIC yet. This documentation-only PR records the parts that belong to EPICs #2264 and #2278 in their specifications, each record linking its Outcome section by path and naming the review that holds it. The #2003 parts are recorded on the EPIC's own open PR #2366.

  • EPIC Refactor Semantic Link and Frontmatter Conventions #2264. A new Decisions Recorded on This EPIC section, placed before Open Questions, records the semantic-linking discussion's four answers (inventory first, pinned to a named develop commit; one kind:value form for every target without a path, with the recount at the sweep's starting head and the note that this touches the frozen v1 convention; tracked files only, with GitHub-hosted records as a dated derived export; where the decisions are recorded) and the goals-and-boundaries parts that name this EPIC (links validated by the purpose of their field; the change-impact field definition split or qualified). The three Open Questions these answer are marked as answered in direction or in part, with a pointer, and the Expected output cells of orders 5 and 7 carry the scope the decisions set. One Progress Log entry and the update stamp.
  • EPIC Strengthen PR review author self-audit and evidence generation #2278. A dated sub-list under Decision Record records the audit-record parts of the goals-and-boundaries Outcome: the record as contract, stamped-or-checked copies of GitHub state as the premise of the validator rows, and epic-owner; it also records that the specifications-and-rationale Outcome, from review 5402713128 (round 3), sends no work to this EPIC. One Progress Log entry and the update stamp.

Files Touched

  • docs/issues/open/2264-2003-refactor-semantic-link-conventions/EPIC.md
  • docs/issues/open/2278-2003-strengthen-pr-review-author-self-audit/EPIC.md
  • docs/discussions/2003-overhaul-guardrails-and-automation/20261003-semantic-linking-knowledge-graph/README.md and …/20261003-goals-and-boundaries/README.md (round 1: the Outcome status sentences now link their records)
  • docs/pr-reviews/pr-2434-review/PR-REVIEW.md (new: the review audit record, extended in round 2)
  • project-words.txt (one word, backlink, which a reviewer finding quoted in the record uses)

Review round 1

F1 (Major) of review 5407866771 is fixed: the two merged discussion Outcomes said none of their answers was recorded in an EPIC and lacked the backlink the convention asks for. docs(discussions): link the #2264 and #2278 records from their Outcomes replaces each Outcome's status sentence with the links to #2264's Decisions Recorded on This EPIC and #2278's Decision Record; the #2003 parts are named as recorded by the overhaul pull request #2366, which replaces that clause with the link when it lands. The audit record carries F1 as FIXED and RESOLVED with its reply URL. The Docs Lint workflow failed on the first pushed head of that round on the word backlink inside the quoted finding; the word is added to the project dictionary rather than rewording the reviewer's text.

Review round 2

Review 5467876260 found no blocking issues and left four non-blocking findings, all fixed in two commits on top of d26ba356c:

A third commit, docs(pr-reviews): [#2264] [#2278] record the PR #2434 round 2 reply URLs, names the four posted replies in the record; the four threads are resolved.

Rebase after PR #2494

PR #2494 merged into develop at 686a42f45 and also changed docs/issues/open/2278-2003-strengthen-pr-review-author-self-audit/EPIC.md, so this branch was rebased onto it; every other file merged cleanly, and the nine commits keep their content apart from that file. The conflict is resolved by keeping both sides: PR #2494's changes to the EPIC (the Decision Record's wording, the notes on rows 5, 8 and 10, AC1, References and its two 2026-10-08 Progress Log entries) and this branch's Decision Record sub-list, with review 5402713128 cited on the specifications-and-rationale bullet, and its 2026-10-04 Progress Log entry, which now sits before the 2026-10-08 entries so the log stays chronological. last-updated-utc is this branch's 2026-10-09 10:41, the round-2 fix, which is later than every entry.

Validation

At this head:

In a Linux container with the workspace nightly toolchain, at the rebased head 072cc27d2, base develop 686a42f45: pre-commit profile gate exit 0 (74 s); linter markdown, linter cspell, linter lychee exit 0; frontmatter-validator --all 19 errors / 4 warnings at this head and at develop re-measured; validate-audit-record.py --pr-number 2434 against the review comments captured after the round-2 replies: 5 rows, 9 log entries, 0 failures; git range-diff against the pre-rebase head shows seven commits equal and two differing only in the resolved EPIC hunks. The earlier heads' results: at 75a7682ee and ebe5e0138 (base 39e5b1b8c), pre-commit profile gate exit 0 (119 s and 147 s), the three linters exit 0, frontmatter-validator --all 22 / 4 at each head and at the base, the audit validator 0 failures at ebe5e0138.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

The source discussion Outcomes remain stale and lack their required links to these canonical records.

Review effort: Balanced
Findings: 1 Low severity

Open (1)
What changed in this PR

Records PR #2428’s design outcomes in EPICs #2264 and #2278.

Changes:

  • Adds semantic-link and path-reference decisions to #2264.
  • Adds audit-record decisions to #2278.
  • Updates progress logs and timestamps.
File Description
docs/​issues/​open/​2264-2003-refactor-semantic-link-conventions/​EPIC.md Records semantic-link decisions and updates affected planning.
docs/​issues/​open/​2278-2003-strengthen-pr-review-author-self-audit/​EPIC.md Records audit-contract decisions.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

da2ce7 added a commit to da2ce7/torrust-tracker that referenced this pull request Oct 4, 2026
Copilot review 5407866771 raised one finding on this pull request: both
discussion Outcomes still said nothing was recorded in an EPIC and lacked
the link to their canonical records. The process-pr-review skill requires
an audit record for every finding, so this records it as F1, Major from its
bracket, FIXED by the Outcome-link commit, with the thread state the skill
prescribes for a concern a change fixed. The reply URL is recorded once the
reply is posted.
da2ce7 added a commit to da2ce7/torrust-tracker that referenced this pull request Oct 4, 2026
The reply on the F1 thread exists now, so the audit record carries its durable URL and the log entry for the push and the reply, as the process-pr-review skill requires before the thread is resolved.
da2ce7 added a commit to da2ce7/torrust-tracker that referenced this pull request Oct 4, 2026
The Docs Lint workflow failed on this branch because cspell does not know the word, which appears in a reviewer's finding quoted verbatim in the PR torrust#2434 audit record. The quoted text stays as written, so the word goes into the project dictionary, and the record's Processing Log notes the failure.

@josecelano josecelano left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review of head d26ba356c. No blocking issues; two Minor accuracy findings (R1, R2) and two Nits (R3, R4) inline.

Checked on this head: all 6 commits GPG-verified; merges cleanly into develop 41add51ab; validate-audit-record.py --pr-number 2434 → 1 row, 0 failures; frontmatter-validator on the touched files, linter markdown, linter cspell, linter lychee → exit 0. The #2264 and #2278 records match the source Outcomes (48 dropped entries, the 53-in-34 recount note, the frozen-v1 caveat, the context-link rule, epic-owner = assignee). F1 is correctly fixed.

Comment thread docs/issues/open/2264-2003-refactor-semantic-link-conventions/EPIC.md Outdated
Comment thread docs/issues/open/2264-2003-refactor-semantic-link-conventions/EPIC.md Outdated
Comment thread docs/pr-reviews/pr-2434-review/PR-REVIEW.md
da2ce7 added a commit to da2ce7/torrust-tracker that referenced this pull request Oct 9, 2026
…'s review of PR torrust#2434

Review 5467876260 left four non-blocking findings. The audit record
gains their rows and detail blocks, R1 to R3 resolved by the previous
commit and R4 by this one. R4 asked for the F1 thread's resolution,
which the log announced but never recorded; the log is append-only and
checked for chronological order, so the entry is appended at the time
of recording and states the resolution's own time in its text.
da2ce7 added a commit to da2ce7/torrust-tracker that referenced this pull request Oct 9, 2026
da2ce7 added 9 commits October 9, 2026 13:21
…scussion outcomes

Records the Outcome section of the semantic-linking discussion (docs/discussions/2003-overhaul-guardrails-and-automation/20261003-semantic-linking-knowledge-graph/README.md, merged in PR torrust#2428) and the goals-and-boundaries Outcome's parts that name this EPIC (the ADR-link purpose rule and the field-definition split) in a new Decisions Recorded on This EPIC section before Open Questions. Three Open Questions are marked as answered in direction or in part with a pointer, the Expected output cells of orders 5 and 7 carry the scope the decisions set, and a Progress Log entry and the update stamp follow.

Related to torrust#2264
…he discussions

Records, under Decision Record, the parts of the goals-and-boundaries discussion's Outcome section (docs/discussions/2003-overhaul-guardrails-and-automation/20261003-goals-and-boundaries/README.md, merged in PR torrust#2428) that bear on the audit record: the record as contract, stamped-or-checked copies of GitHub state as the premise of the validator rows, and epic-owner. It also records that the specifications-and-rationale Outcome sends no work here. A Progress Log entry and the update stamp follow.

Related to torrust#2278
…m their Outcomes

Both Outcome sections said none of their answers was recorded in an EPIC,
which stops being true once this pull request records them in EPICs torrust#2264
and torrust#2278. The discussions convention has a discussion record its outcome
and link the canonical document that carries it (docs/discussions/AGENTS.md,
step 3), and the goals-and-boundaries Outcome itself records that a
discussion is afterwards edited only to repair links. Each status sentence
now names where its answers are recorded instead: the semantic-linking
Outcome links the Decisions Recorded on This EPIC section of EPIC torrust#2264, and
the goals-and-boundaries Outcome links that section and the Decision Record
of EPIC torrust#2278. The EPIC torrust#2003 parts are on its overhaul pull request torrust#2366,
which replaces that clause with a link when it lands. No other text changes.

This fixes review-finding:pr-2434-f1 from Copilot review 5407866771.
Copilot review 5407866771 raised one finding on this pull request: both
discussion Outcomes still said nothing was recorded in an EPIC and lacked
the link to their canonical records. The process-pr-review skill requires
an audit record for every finding, so this records it as F1, Major from its
bracket, FIXED by the Outcome-link commit, with the thread state the skill
prescribes for a concern a change fixed. The reply URL is recorded once the
reply is posted.
The reply on the F1 thread exists now, so the audit record carries its durable URL and the log entry for the push and the reply, as the process-pr-review skill requires before the thread is resolved.
The Docs Lint workflow failed on this branch because cspell does not know the word, which appears in a reviewer's finding quoted verbatim in the PR torrust#2434 audit record. The quoted text stays as written, so the word goes into the project dictionary, and the record's Processing Log notes the failure.
…cord reference and cite the round-3 review

The torrust#2264 record said the four-aspect frame and the discussions
convention are recorded on torrust#2003, which holds only through that EPIC's
open overhaul pull request torrust#2366; it now names that pull request, as
the goals-and-boundaries Outcome does. The torrust#2278 record attributed its
specifications-and-rationale bullet to review 5400754664, while that
Outcome cites review 5402713128 (round 3); the bullet and its Progress
Log entry now cite it. The torrust#2264 Progress Log entry gains the final
period its neighbours have.
…'s review of PR torrust#2434

Review 5467876260 left four non-blocking findings. The audit record
gains their rows and detail blocks, R1 to R3 resolved by the previous
commit and R4 by this one. R4 asked for the F1 thread's resolution,
which the log announced but never recorded; the log is append-only and
checked for chronological order, so the entry is appended at the time
of recording and states the resolution's own time in its text.
@da2ce7
da2ce7 force-pushed the 2264-2278-record-discussion-outcomes branch from ebe5e01 to 072cc27 Compare October 9, 2026 11:23
@da2ce7

da2ce7 commented Oct 9, 2026

Copy link
Copy Markdown
Contributor Author

Rebased onto develop 686a42f45 after PR #2494 merged: the new head is 072cc27d20f49b488f5a005a1ecc2fa6b57b2f5b. The two conflicts were both in the #2278 EPIC, where PR #2494 and this branch each appended Progress Log entries and bumped the stamp; the resolution keeps both sides' entries in stamp order and the later stamp, and changes nothing else. git range-diff against ebe5e0138 shows seven commits equal and the two that touch those hunks differing only there. The gate at the new head is in the description's Validation section.

@josecelano josecelano self-assigned this Oct 10, 2026
@josecelano

Copy link
Copy Markdown
Member

ACK 072cc27

@josecelano
josecelano merged commit f960c78 into torrust:develop Oct 10, 2026
1 check passed
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.

3 participants