Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/handbook/ai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,15 @@ import { Callout } from 'fumadocs-ui/components/callout';
import { DocsPage } from 'fumadocs-ui/page';
docsignore-->

The WAVS Foundry Template contains built-in AI rulefiles for creating "one-shot" components with minimal prompting in Cursor or Claude Code.

The WAVS Foundry Template contains built-in AI rulefiles for creating "one-shot" components with minimal prompting in Cursor or Claude Code.

These rulefiles are an experimental feature and may not work as expected every time. Components created with AI should not be used in production without thorough review and testing.

<Callout title="LLM resources" type="info">
For more information on AI tools and AI-accessible documentation, visit the [LLM resources page](/resources/llms).
</Callout>

## Claude Code

- Follow the [Claude Code installation instructions](https://docs.anthropic.com/en/docs/claude-code/getting-started) to install Claude Code and link your account.
Expand All @@ -32,6 +36,7 @@ These rulefiles are an experimental feature and may not work as expected every t
```sh
git clone https://github.com/Lay3rLabs/wavs-foundry-template.git
cd wavs-foundry-template
git checkout main
# Follow the system setup requirements in the README.
```

Expand Down
44 changes: 44 additions & 0 deletions docs/resources/llms.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
title: LLM docs
description: Access WAVS documentation in formats optimized for AI tools and integration.
---



The LLM text format presents documentation in a clean, plain text format optimized for large language models (LLMs) like Claude, ChatGPT, and others.

## llms.txt

The `llms.txt` format is a structured index of documentation pages organized by sections, including page titles, URLs and descriptions. This format is ideal for AI assistants to understand the documentation structure without processing the full content.

[https://docs.wavs.xyz/llms.txt](https://docs.wavs.xyz/llms.txt)

```
curl https://docs.wavs.xyz/llms.txt
```

## llms-full.txt

The `llms-full.txt` format returns all documentation pages as a single text document.

[https://docs.wavs.xyz/llms-full.txt](https://docs.wavs.xyz/llms-full.txt)

```
curl https://docs.wavs.xyz/llms-full.txt
```

Returns all documentation pages as a single text document.


## Markdown Format

Get any page as standard Markdown by appending `.md` to its URL.

```
curl https://docs.wavs.xyz/path/to/page.md
```

Examples:
- `/overview.md` - Overview page as Markdown
- `/tutorial/1-overview.md` - Tutorial introduction as Markdown
- `/handbook/service.md` - Service handbook as Markdown