52 lines
1.7 KiB
Markdown
52 lines
1.7 KiB
Markdown
# Documentation for LLMs & AI
|
|
|
|
> Source: `src/content/docs/general/docs-for-llms.mdx`
|
|
> Canonical URL: https://rivet.dev/docs/general/docs-for-llms
|
|
> Description: Rivet provides optimized documentation formats specifically designed for Large Language Models (LLMs) and AI integration tools.
|
|
|
|
---
|
|
## Skills (Recommended)
|
|
|
|
For AI coding assistants like Claude Code, Cursor, or Windsurf, install Rivet skills for the best development experience:
|
|
|
|
```sh
|
|
npx skills add rivet-dev/skills
|
|
```
|
|
|
|
Skills provide your AI assistant with Rivet-specific knowledge, best practices, and code patterns directly in your project context.
|
|
|
|
## Available Formats
|
|
|
|
### `llms.txt` (Condensed)
|
|
A condensed version of the documentation perfect for quick reference and context-aware AI assistance.
|
|
|
|
**Access:** <a href="/llms.txt" target="_blank">/llms.txt</a>
|
|
|
|
This format includes:
|
|
- Key concepts and features
|
|
- Essential getting started information
|
|
- Summaries of main functionality
|
|
- Optimized for token efficiency
|
|
|
|
### `llms-full.txt` (Complete)
|
|
The complete documentation in a single file, ideal for comprehensive AI assistance and in-depth analysis.
|
|
|
|
**Access:** <a href="/llms-full.txt" target="_blank">/llms-full.txt</a>
|
|
|
|
This format includes:
|
|
- Complete documentation content
|
|
- All examples and detailed explanations
|
|
- Full API references and guides
|
|
- Suitable for complex queries and comprehensive understanding
|
|
|
|
## Access Pages As Markdown
|
|
|
|
Each documentation page is also available as clean markdown by appending `.md` to any documentation URL path.
|
|
|
|
For example:
|
|
|
|
- Original URL: `https://rivet.dev/docs/actors`
|
|
- Markdown URL: `https://rivet.dev/docs/actors.md`
|
|
|
|
_Source doc path: /docs/general/docs-for-llms_
|