# WAVS Documentation LLM Guide
llms.txt for https://docs.wavs.xyz/
version: 1.0
attribution: Required
attribution_url: https://docs.wavs.xyz/

# Crawl settings
crawl_delay: 1
allow_paths:
  - /
disallow_paths:
  - /private/
  - /drafts/
sitemaps:
  - https://docs.wavs.xyz/sitemap.xml

## Site Overview
This is the official documentation site for WAVS, a next-generation AVS platform that makes it easy to create, manage, and operate high-performance AVSs.

## llms-full.txt

For a complete text version of all documentation pages, use https://docs.wavs.xyz/llms-full.txt

## llm resources

For more llm-ingestible docs, visit https://docs.wavs.xyz/resources/llms.md

## Search API

Search using the search API endpoint: curl "https://docs.wavs.xyz/api/search-custom?q=your_query"
- returns JSON results with page titles, URLs, and content snippets.

## Contributions
The documentation is open-source and accepts contributions. See the GitHub repository for contributing guidelines.

## Support
For additional support or questions not covered in the documentation, users can create issues on GitHub or join the Telegram group.


## Introduction
- [WAVS Docs](https://docs.wavs.xyz): Welcome page with links to WAVS documentation sections
- [Overview](https://docs.wavs.xyz/overview.md): Introduction to WAVS platform and its core concepts
- [WAVS benefits](https://docs.wavs.xyz/benefits.md): Key advantages and use cases of WAVS platform
- [How it works](https://docs.wavs.xyz/how-it-works.md): Technical overview of WAVS architecture and components
- [Docs feedback form](https://docs.google.com/forms/d/e/1FAIpQLSc0rwBm7k71RfHEohXbqwkZb2GztRXrIVpjS95bxIRwpDe4HQ/viewform?usp=pp_url)

## Build a service
- [1. Oracle service tutorial](https://docs.wavs.xyz/tutorial/1-overview.md): Introduction to WAVS tutorial series
- [2. System setup](https://docs.wavs.xyz/tutorial/2-setup.md): Setting up development environment for WAVS
- [3. Create your project](https://docs.wavs.xyz/tutorial/3-project.md): Creating and configuring WAVS project structure
- [4. Oracle component walkthrough](https://docs.wavs.xyz/tutorial/4-component.md): evm-price-oracle component walkthrough
- [5. Build and test components](https://docs.wavs.xyz/tutorial/5-build.md): Building and testing WAVS service components
- [6. Run your service](https://docs.wavs.xyz/tutorial/6-run-service.md): Deploying and running WAVS services
- [7. Prediction market](https://docs.wavs.xyz/tutorial/7-prediction.md): prediction market demo overview

## WAVS builders handbook
- [Handbook overview](https://docs.wavs.xyz/handbook/overview.md): Guide to WAVS handbook structure and contents
- [WAVS design considerations](https://docs.wavs.xyz/design.md): Best practices and design patterns for WAVS services
- [Template overview](https://docs.wavs.xyz/handbook/template.md): Overview of the WAVS foundry template
- [Makefile commands](https://docs.wavs.xyz/handbook/commands.md): CLI commands for WAVS development
- [AI-powered component creation](https://docs.wavs.xyz/handbook/ai.md): Use Claude or Cursor to create one-shot components with minimal prompting
- [Service manifest and manager](https://docs.wavs.xyz/handbook/service.md): Overview of the service.json manifest file and service manager contract
- [Workflows](https://docs.wavs.xyz/handbook/workflows.md): Building and managing WAVS service workflows
- [Triggers](https://docs.wavs.xyz/handbook/triggers.md): Setting up and managing WAVS service triggers
- [Submission and aggregator](https://docs.wavs.xyz/handbook/submission.md): Creating and configuring submission contracts and the aggregator

### Components
- [Component overview](https://docs.wavs.xyz/handbook/components/component.md): Understanding WAVS service components and their structure
- [Variables](https://docs.wavs.xyz/handbook/components/variables.md): Managing configuration variables in WAVS components
- [Network requests](https://docs.wavs.xyz/handbook/components/network-requests.md): Making HTTP requests from WAVS components
- [Blockchain interactions](https://docs.wavs.xyz/handbook/components/blockchain-interactions.md): Interacting with blockchains from WAVS components

## Resources
- [LLM docs](https://docs.wavs.xyz/resources/llms.md): Access WAVS documentation in formats optimized for AI tools and integration.
- [Awesome-WAVS](https://github.com/Lay3rLabs/awesome-WAVS)
- [WAVS Foundry Template](https://github.com/Lay3rLabs/wavs-foundry-template)
- [WAVS-Types Docs](https://docs.rs/wavs-types/0.3.0-alpha5/wavs_types/struct.Service.html)
- [WAVS-WASI-Utils](https://docs.rs/wavs-wasi-utils/latest/wavs_wasi_utils/index.html)