Skip to content

Documentation for LLMs

Fire Shield provides machine-readable documentation optimized for large language models and AI coding assistants.

Available Files

FileSizeDescription
/llms.txt~6 KBIndex — all pages with titles, URLs, and one-line descriptions
/llms-small.txt~370 KBCompact — headings and code blocks only, no prose
/llms-full.txt~435 KBFull — every documentation page concatenated

How to use

In your AI assistant / IDE

Paste the URL directly into your context window or use the file as a reference document:

https://fire-shield.dev/llms.txt       # Start here — links to everything
https://fire-shield.dev/llms-small.txt # For smaller context windows
https://fire-shield.dev/llms-full.txt  # Complete reference

With Claude, ChatGPT, Cursor, etc.

Please read https://fire-shield.dev/llms.txt and help me set up RBAC
for my Express application.

With curl

bash
# Download for offline use
curl -o fire-shield-docs.txt https://fire-shield.dev/llms-full.txt

# Quick API reference
curl https://fire-shield.dev/llms-small.txt | grep -A 20 "## Core API"

File format

All files are plain UTF-8 text. llms-small.txt and llms-full.txt use section separators (===, ---) to delimit pages.

Each page entry in llms.txt follows the format:

- [Page Title](url) — one-line description

Regenerating

The LLM docs are generated from source Markdown during the documentation build:

bash
npm run docs:llms        # Generate only
npm run docs:build       # Generate + build site

These files are auto-generated. Do not edit them manually — edit the source .md files in docs/ instead.