|
|
--- |
|
|
title: "LLMs.txt Documentation" |
|
|
description: |
|
|
How to get tools like Cursor, Windstatic, GitHub Copilot, ChatGPT, and Claude |
|
|
to understand Chakra v3. |
|
|
--- |
|
|
|
|
|
We support [LLMs.txt](https://llmstxt.org/) files for making the Chakra UI v3 |
|
|
documentation available to large language models. |
|
|
|
|
|
|
|
|
|
|
|
The following files are available. |
|
|
|
|
|
- [/llms.txt](https://chakra-ui.com/llms.txt): The main LLMs.txt file |
|
|
- [/llms-full.txt](https://chakra-ui.com/llms-full.txt): The complete |
|
|
documentation for Chakra UI v3 |
|
|
|
|
|
--- |
|
|
|
|
|
Separate docs are available if you have a limited context window. |
|
|
|
|
|
- [/llms-components.txt](https://chakra-ui.com/llms-components.txt): Only |
|
|
component documentation |
|
|
- [/llms-styling.txt](https://chakra-ui.com/llms-styling.txt): Only styling |
|
|
documentation |
|
|
- [/llms-theming.txt](https://chakra-ui.com/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](https://chakra-ui.com/llms-v3-migration.txt): |
|
|
Documentation for migrating to Chakra UI v3 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Use `@Docs` feature in Cursor to include the LLMs.txt files in your project. |
|
|
|
|
|
[Read more](https://docs.cursor.com/context/@-symbols/@-docs) |
|
|
|
|
|
|
|
|
|
|
|
Reference the LLMs.txt files using `@` or in your `.windsurfrules` files. |
|
|
|
|
|
[Read more](https://docs.codeium.com/windsurf/memories#memories-and-rules) |
|
|
|
