LLMs.txt

Ship provides LLM-friendly documentation following the llmstxt.org standard, automatically generated by Mintlify.

​

Available Files

​

llms.txt

A structured list of all documentation pages with links and descriptions. Similar to how a sitemap helps search engines, this file helps AI tools understand your documentation structure.

• View: /llms.txt
• URL: https://ship.paralect.com/docs/llms.txt

​

llms-full.txt

The complete documentation site combined into a single file for full context.

• View: /llms-full.txt
• URL: https://ship.paralect.com/docs/llms-full.txt

​

Key Differences

Use llms.txt when AI tools can fetch pages as needed (ChatGPT, Claude).
Use llms-full.txt when you need all context upfront (Cursor).

​

Usage with AI Tools

​

Cursor

Use the @Docs feature:

1. Type @Docs in your prompt
2. Reference: https://ship.paralect.com/docs/llms-full.txt
3. Ask questions about Ship

​

ChatGPT & Claude

1. Mention you’re using Ship framework
2. Reference: https://ship.paralect.com/docs/llms.txt
3. The AI will fetch the documentation

​

Example Prompts

• “Using Ship framework, how do I create a new API endpoint with validation?”
• “Show me how to set up event handlers in Ship”
• “How to deploy Ship to Digital Ocean?”

​

Learn More

• llmstxt.org standard
• Mintlify llms.txt documentation