|
| 1 | +# Documentation for LLMs & AI |
| 2 | + |
| 3 | +Rivet provides optimized documentation formats specifically designed for Large Language Models (LLMs) and AI integration tools. |
| 4 | + |
| 5 | +## Available Formats |
| 6 | + |
| 7 | +### LLMs.txt (Condensed) |
| 8 | +A condensed version of the documentation perfect for quick reference and context-aware AI assistance. |
| 9 | + |
| 10 | +**Access:** [/llms.txt](/llms.txt) |
| 11 | + |
| 12 | +This format includes: |
| 13 | +- Key concepts and features |
| 14 | +- Essential getting started information |
| 15 | +- Summaries of main functionality |
| 16 | +- Optimized for token efficiency |
| 17 | + |
| 18 | +### LLMs-full.txt (Complete) |
| 19 | +The complete documentation in a single file, ideal for comprehensive AI assistance and in-depth analysis. |
| 20 | + |
| 21 | +**Access:** [/llms-full.txt](/llms-full.txt) |
| 22 | + |
| 23 | +This format includes: |
| 24 | +- Complete documentation content |
| 25 | +- All examples and detailed explanations |
| 26 | +- Full API references and guides |
| 27 | +- Suitable for complex queries and comprehensive understanding |
| 28 | + |
| 29 | +## Individual Page Access |
| 30 | + |
| 31 | +Each documentation page is also available as clean markdown by appending `.md` to any documentation URL path. |
| 32 | + |
| 33 | +### Examples |
| 34 | + |
| 35 | +- **This page as markdown:** [/docs/general/llms.md](/docs/general/llms.md) |
| 36 | +- **Actors overview:** [/docs/actors.md](/docs/actors.md) |
| 37 | +- **State management:** [/docs/actors/state.md](/docs/actors/state.md) |
| 38 | +- **React quickstart:** [/docs/actors/quickstart/react.md](/docs/actors/quickstart/react.md) |
| 39 | + |
| 40 | +### URL Pattern |
| 41 | + |
| 42 | +``` |
| 43 | +Original URL: https://rivet.gg/docs/[path] |
| 44 | +Markdown URL: https://rivet.gg/docs/[path].md |
| 45 | +``` |
| 46 | + |
| 47 | +## Integration Examples |
| 48 | + |
| 49 | +### ChatGPT/Claude Integration |
| 50 | + |
| 51 | +Use the dropdown on any documentation page to: |
| 52 | +- Copy page content directly to clipboard |
| 53 | +- Open the page content in ChatGPT or Claude |
| 54 | +- View the page as raw markdown |
| 55 | + |
| 56 | +### Custom AI Tools |
| 57 | + |
| 58 | +Fetch documentation programmatically: |
| 59 | + |
| 60 | +```javascript |
| 61 | +// Get condensed documentation |
| 62 | +const condensed = await fetch('https://rivet.gg/llms.txt').then(r => r.text()); |
| 63 | + |
| 64 | +// Get complete documentation |
| 65 | +const complete = await fetch('https://rivet.gg/llms-full.txt').then(r => r.text()); |
| 66 | + |
| 67 | +// Get specific page as markdown |
| 68 | +const actorsDoc = await fetch('https://rivet.gg/docs/actors.md').then(r => r.text()); |
| 69 | +``` |
0 commit comments