LLMs.txt Documentation
How to get tools like Cursor, Windstatic, GitHub Copilot, ChatGPT, and Claude to understand Chakra v3.
We support LLMs.txt files for making the Chakra UI v3 documentation available to large language models.
Directory Overview
The following files are available.
- /llms.txt: The main LLMs.txt file
- /llms-full.txt: The complete documentation for Chakra UI v3
Separate docs are available if you have a limited context window.
- /llms-components.txt: Only component documentation
- /llms-styling.txt: Only styling documentation
- /llms-theming.txt: Only theming documentation
We also have a special llms-v3-migration.txt file that contains documentation
for migrating to Chakra UI v3.
- /llms-v3-migration.txt: Documentation for migrating to Chakra UI v3
Usage
Cursor
Use @Docs feature in Cursor to include the LLMs.txt files in your project.
Windstatic
Reference the LLMs.txt files using @ or in your .windsurfrules files.