Skip to content

docs(#530): add backlink guidance for new problem docs#539

Open
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/530-backlink-guidance
Open

docs(#530): add backlink guidance for new problem docs#539
fullsend-ai-coder[bot] wants to merge 1 commit into
mainfrom
agent/530-backlink-guidance

Conversation

@fullsend-ai-coder

Copy link
Copy Markdown

When a new problem doc covers a topic already discussed in existing docs, the author should search docs/problems/ for references to the concept and add reciprocal backlinks in the same PR. This codifies a pattern the maintainer had to apply manually on PR fullsend-ai#3064 and sets the expectation for both authors and reviewers.


Closes #530

Post-script verification

  • Branch is not main/master (agent/530-backlink-guidance)
  • Secret scan passed (gitleaks — b776cf6006a12016eaa21412dc65a3001100e801..HEAD)
  • Pre-commit hooks passed (authoritative run on runner)
  • Tests ran inside sandbox

When a new problem doc covers a topic already discussed in
existing docs, the author should search docs/problems/ for
references to the concept and add reciprocal backlinks in the
same PR. This codifies a pattern the maintainer had to apply
manually on PR fullsend-ai#3064 and sets the expectation for both authors
and reviewers.

Closes #530
@fullsend-ai-review

fullsend-ai-review Bot commented Jul 14, 2026

Copy link
Copy Markdown

🤖 Review · ❌ Terminated · Started 5:36 PM UTC · Ended 5:40 PM UTC
Commit: b776cf6 · View workflow run →

@fullsend-ai-review

Copy link
Copy Markdown

Review — approve

Reviewed: 3e8abce (1 file changed, +1 −0)

Summary

Single-line addition to AGENTS.md that codifies backlink guidance for new problem docs, matching the wording proposed in #530 verbatim. Placed correctly in the "How to work in this repo" bullet list, directly after the existing "link it from README.md" instruction.

Dimensions evaluated

Dimension Result
Correctness ✅ Guidance is technically accurate and internally consistent with existing AGENTS.md rules. No contradictions.
Security ✅ Clean ASCII, no injection patterns, no secrets, no permission changes.
Intent & coherence ✅ Traces to issue #530. Scope matches exactly — no creep.
Style & conventions ✅ Bullet formatting, backtick usage, punctuation, and sentence structure match surrounding lines.
Docs currency ⏭ Not applicable (change is documentation itself).
Cross-repo contracts ⏭ Not applicable (no API/interface changes).

No findings.


Protected paths detected — this PR modifies files under one or more
protected paths. The review agent cannot approve PRs that touch these paths.
A human reviewer must approve this PR.

Protected files in this PR:

  • AGENTS.md

Labels: PR adds contributor guidance to AGENTS.md

@fullsend-ai-review fullsend-ai-review Bot added requires-manual-review Review requires human judgment documentation Improvements or additions to documentation labels Jul 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation requires-manual-review Review requires human judgment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add AGENTS.md guidance: new problem docs should include backlinks from existing docs that reference the topic

0 participants