docs(#373): add backlink guidance for new problem docs - #413
docs(#373): add backlink guidance for new problem docs#413fullsend-ai-coder[bot] wants to merge 2 commits into
Conversation
Extend the problem-doc section of AGENTS.md to require authors to search existing docs for references to their topic and add reciprocal backlinks in the same PR. This codifies the practice demonstrated in PR fullsend-ai#3064, where the maintainer had to manually add backlinks from three existing docs to a new doc. Closes #373
|
🤖 Finished Review · ✅ Success · Started 9:06 AM UTC · Completed 9:12 AM UTC |
Review — approvePR: #413 — docs(#373): add backlink guidance for new problem docs SummaryClean documentation change that adds a new bullet to the AGENTS.md problem-doc section requiring authors to search existing docs for topic references and add reciprocal backlinks in the same PR. The README.md contribution table is updated to match. Dimension results
No findings.
Previous runReviewFindingsMedium
Previous run (2)ReviewFindingsMedium
Low
Previous run (3)ReviewFindingsMedium
Previous run (4)Review — ✅ ApproveReviewed: SummarySingle-line addition to AGENTS.md's "How to work in this repo" section, adding guidance for problem doc authors to search existing docs for references to their topic and add reciprocal backlinks in the same PR. This codifies a manual practice observed on upstream PR fullsend-ai#3064. Dimensions reviewed
NotesDuplicate issue reference (low): Issue #373 is closed with the VerdictThe change is safe to merge. The new guidance is well-placed (immediately after the existing "create and link from README" bullet), correctly scoped to
Labels: PR modifies project governance documentation (AGENTS.md) |
|
/fs-review |
|
🤖 Finished Review · ✅ Success · Started 9:34 AM UTC · Completed 9:42 AM UTC |
|
/fs-fix |
|
🤖 Finished Fix · ✅ Success · Started 9:53 AM UTC · Completed 9:57 AM UTC |
🔧 Fix agent — iteration 1 (human-triggered)No code changes made. Both review findings are process-level concerns, not code bugs. (1) AGENTS.md is a protected path — human approval is already required via the requires-manual-review label. (2) The PR body issue linkage (#373 → #343) requires gh pr edit, which the fix agent cannot use. The PR author should manually update the PR body. Disagreed (2):
Tests: passed Updated by fullsend fix agent |
|
/fs-review |
|
🤖 Finished Review · ✅ Success · Started 1:17 PM UTC · Completed 1:26 PM UTC |
|
/fs-fix |
|
🤖 Finished Fix · ✅ Success · Started 1:50 PM UTC · Completed 1:58 PM UTC |
Update the "Where does my contribution go?" table to mention adding backlinks from existing docs, matching the guidance added to AGENTS.md. Addresses review feedback on #413
🔧 Fix agent — iteration 1 (human-triggered)Updated README.md contributor table to mention the new backlink requirement, keeping it consistent with the AGENTS.md guidance. Disagreed with the protected-path finding (informational only, human approval already required). Fixed (1):
Disagreed (1):
Tests: passed Updated by fullsend fix agent |
|
🤖 Finished Review · ✅ Success · Started 2:04 PM UTC · Completed 2:11 PM UTC |
|
/fs-review |
|
🤖 Finished Review · ✅ Success · Started 6:25 AM UTC · Completed 6:31 AM UTC |
Extend the problem-doc section of AGENTS.md to require authors to search existing docs for references to their topic and add reciprocal backlinks in the same PR. This codifies the practice demonstrated in PR fullsend-ai#3064, where the maintainer had to manually add backlinks from three existing docs to a new doc.
Closes #373
Post-script verification
agent/373-agents-md-backlink-guidance)aa6585ddb3dff17dccfd4dba8b6c5c306275156a..HEAD)