Add llms.txt for LLM-optimized doc discovery#596
Open
ScavieFae wants to merge 1 commit intoinkonchain:mainfrom
Open
Add llms.txt for LLM-optimized doc discovery#596ScavieFae wants to merge 1 commit intoinkonchain:mainfrom
ScavieFae wants to merge 1 commit intoinkonchain:mainfrom
Conversation
Ink's docs currently return 404 at /llms.txt. This adds a structured index following the llmstxt.org spec so AI coding assistants (Cursor, Claude Code, Copilot, etc.) can discover and navigate Ink's developer documentation. Covers all ~43 live doc pages, organized by developer workflow. RPC endpoints and chain IDs are inlined for zero-click access. Uses the spec's ## Optional section for non-essential pages.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
public/llms.txtfollowing the llmstxt.org spec — Ink currently returns 404 at/llms.txt## Optionalsection to deprioritize non-essential pages (FAQ, Community, Brand Kit)Why
Developers increasingly use AI coding assistants (Cursor, Claude Code, Copilot) to scaffold projects. When someone asks "help me deploy a contract on Ink," the assistant has no structured entry point to Ink's docs — it either hallucinates outdated info or falls back to generic OP Stack docs.
Both Base and Optimism already serve
llms.txt. Ink is the only major Superchain network without one.Design choices
/build/kraken-verify)Suggested follow-up
Serve
.mdversions of high-traffic pages (Getting Started, Onchain Clients, deployment tutorials, contract address tables). The spec supports this aspage-url.md— low-effort on Nextra since the source is already Markdown.Test plan
llms.txtis served atdocs.inkonchain.com/llms.txtafter deploy