Skip to main content

LLMs.txt

This page explains how to use this website's llms.txt and llms-full.txt with AI tools for more accurate, context-aware help.

Links:

What are llms.txt and llms-full.txt?​

  • llms.txt: Compact, curated index of the most important pages and concepts. AI tools can quickly fetch and ground answers using this file.
  • llms-full.txt: Larger, more exhaustive index that includes deeper sections. Useful for comprehensive assistance or offline indexing.

When to use which​

  • Use llms.txt for quick, focused questions (most cases).
  • Use llms-full.txt for broad explorations, deep refactors, or when you need maximum coverage.

How to use with AI tools​

Cursor​

  1. In a prompt, reference the docs: @Docs https://help.appdirect.com/llms.txt (or use /llms-full.txt when needed).
  2. Ask your question, e.g.:
Using https://help.appdirect.com/llms-full.txt, map the end‑to‑end subscription lifecycle (order → provisioning → billing → suspension → cancelation). For each phase, cite the specific docs (APIs, webhooks, Event Logs) and list required inputs/outputs.

Windsurf​

  • Add @https://help.appdirect.com/llms.txt in the prompt.
  • Or add it to your .windsurfrules for persistent access.

ChatGPT / Claude​

Include the version and link in your prompt:

We are using the AppDirect docs. Reference: https://help.appdirect.com/llms.txt
Summarize the Product → Products section and outline the APIs I should review first.

Example prompts for this website​

  • Using https://help.appdirect.com/llms-full.txt, map the end‑to‑end subscription lifecycle (order → provisioning → billing → suspension → cancelation). For each phase, cite the specific docs (APIs, webhooks, Event Logs) and list required inputs/outputs.
  • Using https://help.appdirect.com/llms.txt, explain how proration works for mid‑cycle plan upgrades/downgrades. Walk through a concrete invoice example (dates, quantities, credits) and link the exact Billing/Pricebooks and Invoices pages used.
  • Using https://help.appdirect.com/llms-full.txt, produce a VAT/GST compliance checklist: tax configuration, invoice templates, rounding, credit notes, and reporting. Provide direct links to each step under Platform → Billing and Reports.
  • Using https://help.appdirect.com/llms.txt, design a multi‑region catalog strategy. Cross‑reference Products, Product Associations, and Pricebooks to map editions to regions/currencies. Propose a SKU split migration plan with linked pages.
  • Using https://help.appdirect.com/llms.txt as context, compare OAuth vs API keys for integrations. Give step‑by‑step: register an app, request scopes, perform token exchange/refresh, and call a sample API. Cite the exact authentication docs.
  • Using https://help.appdirect.com/llms-full.txt, enumerate all webhook/event types during checkout and provisioning. Include payload fields, idempotency, retries, and failure handling. Link to Event Logs and the related feature docs.

Best practices​

  • Prefer llms.txt first; switch to llms-full.txt only when you need broader coverage.
  • Provide direct links in your prompts so the AI can cite exact pages.
  • Be explicit about the product area: Platform, Product, or Reseller.
  • Ask for short summaries with verified links, then dive deeper as needed.

Troubleshooting​

  • If the AI misses context, reference a specific subsection URL directly from the docs instead of a generic query.
  • If results look outdated, mention that you’re using the live site and re-include https://help.appdirect.com/llms.txt in the prompt to refresh context.