Redocly / Redocly/redoc

Provide an LLM-friendly aggregated documentation file at /llms.txt

Open
#2,709 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Type: Enhancement
Dominant language
TypeScript
Stars
25.9k
Forks
2.4k
Avg merge
13h 10m
Merged PRs (30d)
4

Description

Problem
At present, anyone who wants to give an LLM-powered IDE, copilot, or agent access to a framework’s documentation has to manually assemble and maintain their own bundles. This leads to duplication of effort, inconsistencies across projects, and fragile solutions that quickly go out of date.

Proposed Solution
Adopt the emerging https://llmstxt.site convention for providing a standardized, LLM-readable entry point to a project’s documentation.

  • Publish a root-level /llms.txt file containing concise background information about the framework and curated links to key Markdown-based documentation.
  • Ensure that each linked page has a clean .md version (e.g. page.html.md) so that LLMs can parse it directly, free from ads, navigation chrome, or JavaScript.
  • Optionally provide expanded context files (e.g. llms-ctx.txt, llms-ctx-full.txt) generated from the /llms.txt contents for agents that prefer single-file ingestion.

This would give LLM agents a reliable, consistent way to access the framework’s knowledge base at inference time, without requiring custom preprocessing.

Alternatives considered

  • Manually creating and distributing ad-hoc documentation bundles.

    • ❌ Time-consuming
    • ❌ Error-prone
    • ❌ Not standardized across ecosystems

Prior art / examples

  • FastHTML implements this approach, with .md versions of each docs page and context-expanded files for LLM consumption.
  • AG-UI demonstrates a full aggregated file for agents.

Benefits

  • Standardized entry point for LLM agents and IDEs
  • Easy discoverability (/llms.txt, like /robots.txt or /sitemap.xml)
  • Reduces duplication across projects
  • Helps maintain accurate, up-to-date, and concise context windows

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No repository files or tests are identified in the issue. Start by locating the documentation generation and publishing entry points, then determine how /llms.txt and clean .md pages would be produced and kept current. Done means the documented entry point and any agreed context files are available and reflect the published documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.