Usage with AI Tools
AI tools work best when they can read documentation in a structured, efficient format. Silk provides several ways to do that:
- an
llms.txtfile listing the main pages and documentation entry points; - a bundled Markdown version of the full documentation,
docs-full.md; - a Markdown version of every documentation page at the same URL with
.md.
Start with llms.txt
If your AI tool supports llms.txt, this is the best place to start.
It gives the tool a structured overview of the Silk website and documentation, and helps it fetch only the pages it actually needs. This usually leads to better results while using less context than providing the full documentation up front.
The llms.txt file includes:
- a summary of what Silk is;
- links to the main website pages;
- links to the documentation pages;
- a link to the bundled full documentation.
Use a specific Markdown page
If you want to give an AI tool a single documentation page, each docs page is also available as Markdown by adding .md to its URL.
For example:
/docs/getting-started→/docs/getting-started.md/docs/sheet→/docs/sheet.md/docs/scroll→/docs/scroll.md
This is the best option when you need help with one specific component, hook, or guide.
Use the full bundled documentation
If your AI tool needs broader context, Silk also provides the full documentation as a single bundled Markdown file, docs-full.md.
This is useful when the tool needs a wider view of the library, or when it does not support llms.txt but can ingest a larger documentation source.