Skip to content

docs: add llms.txt for AI/LLM documentation access#12807

Open
affaan-m wants to merge 1 commit intoanomalyco:devfrom
affaan-m:add-llms-txt
Open

docs: add llms.txt for AI/LLM documentation access#12807
affaan-m wants to merge 1 commit intoanomalyco:devfrom
affaan-m:add-llms-txt

Conversation

@affaan-m
Copy link
Copy Markdown
Contributor

@affaan-m affaan-m commented Feb 9, 2026

Summary

Adds a comprehensive llms.txt file to the repository root, providing structured documentation optimized for LLM consumption.

Closes #8816

What's included

The llms.txt covers all major OpenCode features:

  • Installation — all package managers, platforms, Docker
  • Configurationopencode.json schema, core settings, env vars
  • Agents — built-in agents, custom agent config (JSON + markdown formats), all config options
  • Commands — built-in + custom commands, template variables, options
  • Tools — all 14 built-in tools, permissions system, custom tool definitions with Zod schema
  • Plugins — plugin structure, hook events (25+ events documented), loading methods, examples
  • Providers — 75+ providers, config format, model naming, API key setup
  • MCP — server configuration, tool permissions
  • Ecosystem — plugin categories, discovery resources
  • Quick Reference — keyboard shortcuts, commands, file locations, troubleshooting

Why

Test plan

  • Verify llms.txt renders correctly on GitHub
  • Validate all documented features match current OpenCode behavior
  • Check for any outdated configuration examples

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Feb 9, 2026

The following comment was made by an LLM, it may be inaccurate:

No duplicate PRs found

@deadcoder0904
Copy link
Copy Markdown

This uses way too many tokens, no?

https://bun.com/llms.txt seems much smaller & better.

The previous PR did just that with https://delucis.github.io/starlight-llms-txt/

I think this one is equivalent to llms-full.txt

@affaan-m
Copy link
Copy Markdown
Contributor Author

This uses way too many tokens, no?

https://bun.com/llms.txt seems much smaller & better.

The previous PR did just that with https://delucis.github.io/starlight-llms-txt/

I think this one is equivalent to llms-full.txt

yeah you're right i meant for it to be llms-full.txt

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE]: provide llms.txt and docs as markdown

2 participants