Skip to content

AGENTS.md: fix relref build-failure claim, add .md-extension rule #3903

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kaitlynmichael merged 1 commit into from
Sep 1, 2026
Merged

AGENTS.md: fix relref build-failure claim, add .md-extension rule #3903

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,9 @@ around a literal, rewrite the sentence.
## Site mechanics

- **Cross-references use the relref shortcode**, not markdown paths:
`{{< relref "/operate/rs/clusters/new-cluster-setup" >}}`. A broken relref fails the
build. Link text is descriptive — never "click here" or a bare URL.
`{{< relref "/operate/rs/clusters/new-cluster-setup" >}}`. The path never ends in
`.md`. A broken relref warns at build time and must still be fixed — it resolves to
the wrong page or a 404. Link text is descriptive — never "click here" or a bare URL.
- **Preserve shortcodes, frontmatter, and code fences verbatim.** Do not reformat them.
- **Frontmatter**: copy the shape from a sibling page in the same directory rather than
composing one. `title` and `linkTitle` are effectively universal; `description`,
Expand Down
Loading