[ARCHIVED] Benchmark issue 485 - #485
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
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
|
/fs-review |
|
🤖 Finished Review · ✅ Success · Started 10:22 AM UTC · Completed 10:27 AM UTC |
ReviewFindingsMedium
Labels: PR title tags indicate LSP experiment and RTK+Ponytail methodology context. Previous runReview — approveScope: AGENTS.md (+1 bullet), README.md (+1 table cell edit) — documentation-only, 2 additions / 1 deletion. SummaryClean, well-scoped documentation change that codifies the backlink expectation for new problem docs. The new AGENTS.md bullet matches the phrasing proposed in issue #484 almost verbatim, and the README.md table cell mirrors the same guidance at the contribution entry point. Dimensions evaluated
No findings at any severity level.
Labels: PR is a documentation-only change to AGENTS.md and README.md |
|
🤖 Finished Review · ✅ Success · Started 10:28 AM UTC · Completed 10:38 AM UTC |
| - Problem documents (`docs/problems/`) should present multiple options with trade-offs, not prescribe single solutions. | ||
| - Each problem document has an "Open questions" section — this is where unresolved issues live. | ||
| - When adding new problem areas, create a new file in `docs/problems/` and link it from `README.md`. | ||
| - When a new problem doc covers a topic already mentioned in existing docs, search for references to the concept across `docs/problems/` and add backlinks from those existing docs to the new doc in the same PR. This ensures readers can discover the new doc from its related contexts. |
There was a problem hiding this comment.
[medium] protected-path
AGENTS.md is a protected governance file. This PR modifies it to add backlink guidance for new problem documents. The PR links to issue #484, which provides clear rationale from a retrospective analysis. Human approval is always required for protected-path changes, regardless of context.
Closes #484
LSP experiment v2: clean first-review with gopls-lsp enabled.
Code identical to PR #413 (issue #373).
Branch created from commit ad9d6bd.