Skip to content

fix(infra): agent-friendly docs spec v0.5.0 — easy compliance wins #182

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
marc0olo merged 1 commit into from
Apr 30, 2026
Merged

fix(infra): agent-friendly docs spec v0.5.0 — easy compliance wins #182

Show file tree
Hide file tree
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: 4 additions & 1 deletion plugins/astro-agent-docs.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,9 @@ const SECTIONS = deriveSections(sidebar);
// a charset=utf-8 in the Content-Type header.
const BOM = "\uFEFF";

const LLMS_TXT_DIRECTIVE =
"> For the complete documentation index, see [llms.txt](/llms.txt)\n\n";

/** Strip YAML frontmatter, HTML comments, and MDX artifacts; prepend title heading. */
function cleanMarkdown(raw, isMdx = false) {
const { data, content } = matter(raw);
Expand All @@ -96,7 +99,7 @@ function cleanMarkdown(raw, isMdx = false) {
}
body = body.replace(/\n{3,}/g, "\n\n").trim();
const title = data.title ? `# ${data.title}\n\n` : "";
return BOM + title + body + "\n";
return BOM + title + LLMS_TXT_DIRECTIVE + body + "\n";
}

/**
Expand Down
2 changes: 2 additions & 0 deletions public/_headers
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/*.md
Content-Type: text/markdown; charset=utf-8
Loading