Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,6 @@ node_modules
html2md_converter/go.sum
html2md_converter/go.mod
html2md_converter/html-to-md

# LLM artifacts
llms*.txt
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,25 @@ Install the Mintlify dev tool: `npm install -g mint`
Then run `mint dev` to get a locally-running site.

Send a PR to get a hosted preview of the changes.

## LLM-friendly snapshots

The repository now ships a family of machine-readable files at the site root:

- `llms.txt` – curated index linking out to every other variant.
- `llms-medium.txt` – abridged narrative with limited excerpts.
- `llms-small.txt` – compressed quick-reference for low-token contexts.
- `llms-full.txt` – the entire Markdown/MDX corpus in one file.
- `llms-section-<slug>.txt` – section-scoped corpora (for example `llms-section-user-guide.txt`).

Regenerate all variants after editing docs:

```bash
python3 scripts/generate_llms.py
```

Hints:

- Set `LLMS_BASE_URL` if you need to point to a preview/staging domain.
- Use `--sections-only about-bazel user-guide` to regenerate just the per-section files you touched.
- Run `mint dev` and visit `http://localhost:3000/llms.txt` (or `/llms-medium.txt`, etc.) to preview locally.
Loading
Loading