AGENTS.md: fix relref build-failure claim, add .md-extension rule - #3903
Merged
Conversation
A broken relref warns at build time rather than failing it, and the convention file said the opposite -- this was known before #3826 merged but never pushed. Also documents that relref paths never carry a .md extension.
Contributor
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at f72414e |
mich-elle-luna
approved these changes
Aug 31, 2026
EliShteinman
added a commit
to EliShteinman/docs
that referenced
this pull request
Sep 5, 2026
Corrects the AGENTS.md relref rule: a broken relref warns at build time rather than failing it, and relref paths never carry a .md extension. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WycKvjyQaCQQBwVEkvSAKT
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
2 participants
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
AGENTS.md's claim that a broken relref fails the build — it only warns, per David's earlier finding in Infra: Agents.md for contributors using AI #3826 (never pushed before that PR merged)..mdextension.Test plan
Note
Low Risk
Documentation-only change to contributor conventions; no runtime, security, or product behavior impact.
Overview
Updates Site mechanics guidance for Hugo
relrefcross-references inAGENTS.md.Broken relrefs are described accurately: they warn at build time rather than failing the build, while still requiring a fix because they can land on the wrong page or a 404.
A new rule states that relref paths must not end in
.md, with the example path unchanged. The bullet is also reformatted from a nested continuation line into a single block under the cross-reference item.Reviewed by Cursor Bugbot for commit f72414e. Bugbot is set up for automated code reviews on this repo. Configure here.