Skip to content

Add structured, prerendered docs /llms.txt for AI discovery #42812

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

Closed
Copilot wants to merge 2 commits into from
Closed

Add structured, prerendered docs /llms.txt for AI discovery #42812

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ddb3c41
Initial plan
Copilot Jul 1, 2026
9e9435c
Add structured docs llms.txt endpoint content
Copilot Jul 1, 2026
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
34 changes: 32 additions & 2 deletions docs/src/pages/llms.txt.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,47 @@
import type { APIRoute } from 'astro';
import { getAwPrompts } from './_aw-prompts.js';

export const prerender = true;

export const GET: APIRoute = () => {
const prompts = getAwPrompts();

const lines = [
'# GitHub Agentic Workflows',
'',
'> Agent-optimised prompt files for GitHub Agentic Workflows (gh-aw).',
'> These markdown files are designed for AI agents and LLMs, not human readers.',
'> Official documentation and reference index for GitHub Agentic Workflows (gh-aw).',
'> Optimized for AI systems to discover key docs, examples, API/reference content, and project context.',
'',
'## Docs',
'',
'- [Documentation Home](https://github.github.com/gh-aw/)',
'- [Quick Start](https://github.github.com/gh-aw/setup/quick-start/)',
'- [Creating Workflows](https://github.github.com/gh-aw/setup/creating-workflows/)',
'- [Workflow Examples](https://github.github.com/gh-aw/examples/)',
'- [Workflow Patterns](https://github.github.com/gh-aw/patterns/)',
'',
'## Blog',
'',
'- [Blog Home](https://github.github.com/gh-aw/blog/)',
'- [What is GitHub Agentic Workflows?](https://github.github.com/gh-aw/blog/2026-01-13-meet-the-workflows/)',
'',
'## API / Reference',
'',
'- [CLI Reference](https://github.github.com/gh-aw/reference/cli/)',
'- [Workflow Syntax Reference](https://github.github.com/gh-aw/reference/workflow-syntax/)',
'- [Engine Reference](https://github.github.com/gh-aw/reference/engines/)',
'- [MCP Server Reference](https://github.github.com/gh-aw/reference/gh-aw-as-mcp-server/)',
'',
'## About',
'',
'- [About gh-aw](https://github.github.com/gh-aw/about/)',
'- [Contributing](https://github.com/github/gh-aw/blob/main/CONTRIBUTING.md)',
'',
'## Agent Prompts',
'',
'- [Agent Prompt Index](https://github.github.com/gh-aw/agents.txt)',
'- [Full Prompt Corpus](https://github.github.com/gh-aw/llms-full.txt)',
'',
...prompts.map(({ file, description, rawUrl }) => {
const label = file.replace(/\.md$/, '');
return description
Expand Down