Using llms.txt

The Earth Design System provides an llms.txt file to help AI coding assistants and large language models (LLMs) better understand and navigate our documentation.

The llms.txt file is a structured, machine-readable index of our documentation that follows the llms.txt standard. It provides LLMs with:

• Quick navigation – Links to all components, foundations, widgets, and guides
• Context-aware descriptions – Brief, informative summaries of each resource
• Organized structure – Logical grouping by category for efficient discovery
• Up-to-date content – Automatically generated from our documentation source

When working with AI coding assistants like Claude Code, Cursor, or Windsurf, providing them with our llms.txt file helps them:

• Find the right components faster without searching through documentation
• Understand component APIs and usage patterns accurately
• Follow design system conventions and best practices
• Generate code that aligns with Earth Design System standards
• Answer questions about components, styling, and implementation

Claude Code offers a built-in shortcut to save documentation URLs directly to your project’s persistent memory.

In your active Claude Code session, use the # command to instantly add the Earth Design System to your project's CLAUDE.md or MEMORY.md:

# remember that @adaptavant/eds-core docs are at https://earth.anywhere.co/llms.txt

Use the @Docs feature to include Earth Design System documentation:

Type @Docs → Add new doc → Paste https://earth.anywhere.co/llms.txt

Project-Wide Rules (.cursor/rules): To ensure Cursor always follows Earth DS standards, add this to .cursor/rules/eds.md:

Markdown

---
description: Earth Design System standards
globs: ["**/*.tsx", "**/*.jsx"]
---
Always prioritize the @adaptavant/eds-core patterns found here:
https://earth.anywhere.co/llms.txt

For VS Code users, the best integration method is using Custom Instructions to point Copilot to the machine-readable index.

(.github/copilot-instructions.md): Add this block to your project's Copilot instructions:

//copilot-instructions.md

# @adaptavant/eds-core Standards
Reference the official LLM-friendly documentation index for all component logic:
- Index: https://earth.anywhere.co/llms.txt
- Full Reference: https://earth.anywhere.co/llms-full.txt

1. Combine with Specific Questions

Instead of just loading the documentation, ask specific questions:

Using Earth Design System's llms.txt, how do I implement
a responsive navigation bar with dropdown menus?

2. Reference Component Categories

When you know the category, mention it for faster results:

From the Earth Design System layout components, show me
how to use Stack and Track together.

3. Ask for Code Examples

Request practical examples that follow EDS conventions:

Generate a form using Earth Design System components
with proper validation and error handling.

4. Verify Deprecated Features

Always check for deprecation warnings in responses:

Is the Icon component from @adaptavant/eds-core still
recommended, or should I use the icons package?

Creating a New Feature

I'm building a user profile page. Using Earth Design System's
llms.txt, suggest the best components for:
- Profile header with avatar
- Editable form fields
- Action buttons
- Responsive layout

Migrating from Another Library

I'm migrating from Material-UI to Earth Design System. Using
the llms.txt, what are the equivalent components for:
- TextField → ?
- Dialog → ?
- Chip → ?

Troubleshooting

I'm getting type errors with the Box component's 'as' prop.
According to Earth Design System's llms.txt, what's the
correct way to use polymorphic components?

While llms.txt provides comprehensive coverage, be aware that:

• Context window limits – Very large projects may need to reference specific component documentation
• Version specificity – The file represents the latest version; for older versions, check the changelog
• Interactive examples – Some interactive demos are better explored in the live documentation
• Visual references – Screenshots and visual examples require visiting the actual docs

If you find the ‎llms.txt file missing important information or have suggestions for improvement, please reach out to the Earth Design System team. The llms.txt format is evolving, and we welcome community feedback to make our documentation more accessible to AI tools.