Skip to content

docs: clarify link checking rules in AGENTS.md#4993

Merged
devalog merged 1 commit intomainfrom
devin/1776453668-agents-md-link-checking
Apr 17, 2026
Merged

docs: clarify link checking rules in AGENTS.md#4993
devalog merged 1 commit intomainfrom
devin/1776453668-agents-md-link-checking

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

Summary

Tightens the "Link checking" section of AGENTS.md so agents constructing internal URLs don't get tripped up by cases the current doc glosses over:

  • Adds skip-slug: true to the URL segment table and callout. It's used in fern/products/docs/docs.yml (e.g., the nested Navigation section) and fern/products/api-def/api-def.yml, so walking the section hierarchy naively will produce broken URLs.
  • Generalizes the Home product footnote: any product/section/tab with no slug: (or with skip-slug: true) is omitted from the URL, not just Home.
  • Clarifies slug precedence in the "Steps to construct a link" list: page frontmatter slug: wins over slug: in the navigation YML, which wins over the auto-derived value.

No content changes outside AGENTS.md.

Review & Testing Checklist for Human

  • Read through the updated "Link checking" section in AGENTS.md and confirm the new wording matches how you want agents to reason about URLs (especially the frontmatter > YAML slug precedence and the skip-slug: true handling).

Notes

Scope is intentionally small — this only edits AGENTS.md. No docs pages or config changed, so there's nothing meaningful to preview on the site.

Link to Devin session: https://app.devin.ai/sessions/a135a71acfa04edab4df6daa04f90a27
Requested by: @devalog

Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Copy Markdown
Contributor

@devalog devalog merged commit 346fdfe into main Apr 17, 2026
3 checks passed
@devalog devalog deleted the devin/1776453668-agents-md-link-checking branch April 17, 2026 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant