Skip to Content
DevelopmentBest practicesLLM-friendly docs

LLM-friendly documentation

From this guide, you’ll learn how to use Prepr’s machine-readable documentation formats with AI coding assistants for faster, more accurate development.

Introduction

Prepr’s documentation is available in LLM-friendly formats that make it easy to integrate with AI coding assistants like Claude, ChatGPT, Cursor, and GitHub Copilot. These formats follow the llms.txt  standard, providing machine-readable documentation that AI assistants can use as context when helping you build with Prepr.

By adding Prepr documentation to your AI assistant, you’ll get:

  • Accurate answers based on the latest Prepr documentation
  • Code suggestions that follow Prepr best practices
  • Faster development with context-aware assistance
  • Reduced errors from outdated or incorrect information

Available formats

Prepr documentation is available in three LLM-friendly formats:

llms.txt

The llms.txt file provides an index of all documentation pages with titles and descriptions.

URL: https://docs.prepr.io/llms.txt

Best for: Quick reference and helping AI assistants find relevant documentation sections.

llms-full.txt

The llms-full.txt file contains the complete Prepr documentation in a single, machine-readable text file.

URL: https://docs.prepr.io/llms-full.txt

Best for: Providing full context to AI assistants for comprehensive answers about Prepr.

Markdown format (.md)

Any documentation page can be accessed in markdown format by appending .md to the URL.

Example: https://docs.prepr.io/graphql-api.md

Best for: Getting the raw markdown content of individual pages for focused context.

Using with AI

Claude Projects

Claude Projects  allow you to add documentation as project knowledge, giving Claude context for all conversations within that project.

  1. Open Claude.ai  and create a new Project or open an existing one.
  2. In the project settings, navigate to the Files section.
  3. Click + and choose one of these options:
    • Add file: Download https://docs.prepr.io/llms-full.txt to your computer and upload the file
    • Add text content: Paste a link to https://docs.prepr.io/llms-full.txt in the text field
  4. Claude will process and index the documentation.

Now Claude can reference Prepr documentation when answering your questions about building with Prepr CMS.

You can also add specific documentation pages by using the .md format, for example: https://docs.prepr.io/graphql-api/get-started.md

ChatGPT

There are two ways to use Prepr documentation with ChatGPT:

Option 1: Create a Project

  1. Go to ChatGPT  and create a new Project.
  2. In the project settings, find the Project files section.
  3. Download https://docs.prepr.io/llms-full.txt to your computer.
  4. Upload the downloaded file to the project.

All chats within this project will have access to the Prepr documentation.

Option 2: Build a Custom GPT

Custom GPTs  let you create specialized assistants with tailored knowledge.

  1. Navigate to the GPT Builder .
  2. Click Create a GPT.
  3. Switch to the Configure tab and locate the Knowledge section.
  4. Download https://docs.prepr.io/llms-full.txt and upload the file.
  5. Add instructions such as: “You are a Prepr CMS specialist. Use the provided documentation to answer questions about headless CMS development, content modeling, and GraphQL API usage. Provide code examples when applicable.”

Custom GPTs and Projects require a ChatGPT Plus or Team subscription. Free users can paste relevant documentation sections directly into their conversations.

Cursor

Cursor  is an AI-first code editor that can reference documentation directly.

  1. Open a chat in Cursor.
  2. Type @Docs in the chat input.
  3. Scroll down and click Add new doc.
  4. Paste the URL: https://docs.prepr.io/llms.txt
  5. Set docs name to Prepr

Now you can reference Prepr documentation in your prompts using @Prepr or by typing @ and selecting Prepr from the documentation sources.

Example prompt:
@Prepr How do I fetch a single content item by slug using the GraphQL API?

Tips for using AI assistants with Prepr

Stay up to date: Prepr documentation is continuously updated with new features and improvements. Periodically refresh the documentation in your AI assistant to ensure you’re getting the latest information.

Combine with code context: AI assistants work best when they have both documentation and your project’s code context. Share relevant code snippets along with your questions for more accurate suggestions.

Verify critical information: While AI assistants are helpful, always verify critical implementation details like API endpoints, authentication methods, and data schemas against the official documentation.

If you have any questions about using Prepr with AI assistants, please contact our Support team .

Last updated on
WebhooksWorking with CI/CD