Skip to content

Serve markdown indexes for the docs root and section hubs to agents#4996

Open
philip wants to merge 1 commit into
mainfrom
docs/add-markdown-dir-indexes
Open

Serve markdown indexes for the docs root and section hubs to agents#4996
philip wants to merge 1 commit into
mainfrom
docs/add-markdown-dir-indexes

Conversation

@philip
Copy link
Copy Markdown
Collaborator

@philip philip commented Jun 1, 2026

Summary

  • Agents and Accept: text/markdown requests to the docs root (/docs and /docs.md) now receive the curated llms.txt index instead of a redirect or 404. Browsers still land on /docs/introduction.
  • Appending .md to a top-level section root (faqs, guides, branching, programs, use-cases, postgresql) now returns a markdown listing of that section's pages, so "append .md to any URL" holds for hubs too.
  • Fixed the markdown path and canonical URL for programs and use-cases pages, which were previously served under an incorrect path.
  • Non-page content (shared includes, READMEs, templates) is no longer emitted as standalone markdown, making markdown and HTML behavior consistent.
  • Internal: de-duplicated shared content helpers; no behavior change.

Test plan

  • /docs with Accept: text/markdown and with an agent User-Agent returns the llms.txt index; a browser is redirected to /docs/introduction.
  • /docs.md and the section .md indexes return markdown listings.
  • programs/use-cases pages resolve as markdown at their correct URLs.
  • Unit suites pass; markdown URL QA suite passes against the preview deploy.

@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 1, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
neon-next Ready Ready Preview, Comment Jun 1, 2026 8:11pm

Request Review

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