Skip to content

Commit 571c590

Browse files
dawnkelly09dawnkelly09
committed
fresh llms
1 parent 6dd5fac commit 571c590

File tree

3 files changed

+121
-107
lines changed

3 files changed

+121
-107
lines changed

‎ai/pages/get-support-ai-ready-docs.md‎

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,33 @@ url: https://docs.polkadot.com/get-support/ai-ready-docs/
66

77
# AI Ready Docs
88

9-
Polkadot provides `.txt` files containing the documentation content and navigation structure, optimized for use with large language models (LLMs) and AI tools. These resources help build AI assistants, power code search, or enable custom tooling trained on Polkadot’s documentation.
9+
Polkadot provides files to make documentation content available in a structure optimized for use with large language models (LLMs) and AI tools. These resources help build AI assistants, power code search, or enable custom tooling trained on Polkadot’s documentation.
1010

11-
Each category file includes foundational content from the **Basics** and **Reference** categories to ensure LLMs have the necessary context.
11+
## How to Use These Files
12+
13+
- **Quick navigation**: Use `llms.txt` to give models a high-level map of the site.
14+
- **Lightweight context**: Use `site-index.json` for smaller context windows or when you only need targeted retrieval.
15+
- **Full content**: Use `llms-full.jsonl` for large-context models or preparing data for RAG pipelines.
16+
- **Focused bundles**: Use category files (e.g., `basics.md`, `parachains.md`) to limit content to a specific theme or task for more focused responses.
17+
18+
These AI-ready files do not include any persona or system prompts. They are purely informational and can be used without conflicting with your existing agent or tool prompting.
1219

1320
## Download LLM Files
1421

15-
| Category | Description | File | Actions |
16-
|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
17-
| Index | Navigation index of all Polkadot documentation pages. | `llms.txt` | [:octicons-copy-16:](){ .llms data-action="copy" data-value="llms.txt" } [:octicons-download-16:](/llms.txt){ download="llms.txt" } |
18-
| Full Documentation | Full content of all documentation pages. | `llms-full.txt` | [:octicons-copy-16:](){ .llms data-action="copy" data-value="llms-full.txt" } [:octicons-download-16:](/llms-full.txt){ download="llms-full.txt" } |
19-
| Basics | Polkadot general knowledge base to provide context around overview and beginner level content. | `llms-basics.txt` | [:octicons-copy-16:](){ .llms data-action="copy" data-value="llms-basics.txt" } [:octicons-download-16:](/llms-files/llms-basics.txt){ download="llms-basics.txt" } |
20-
| Reference | Reference material including key functions and glossary. | `llms-reference.txt` | [:octicons-copy-16:](){ .llms data-action="copy" data-value="llms-reference.txt"} [:octicons-download-16:](/llms-files/llms-reference.txt){ download="llms-reference.txt" } |
21-
| Smart Contracts | How to develop and deploy Solidity smart contracts on Polkadot Hub. | `llms-smart-contracts.txt` | [:octicons-copy-16:](){ .llms data-action="copy" data-value="llms-smart-contracts.txt" } [:octicons-download-16:](/llms-files/llms-smart-contracts.txt){ download="llms-smart-contracts.txt" } |
22-
| Parachains | How to guides related to building, customizing, deploying, and maintaining a parachain. | `llms-parachains.txt` | [:octicons-copy-16:](){ .llms data-action="copy" data-value="llms-parachains.txt" } [:octicons-download-16:](/llms-files/llms-parachains.txt){ download="llms-parachains.txt" } |
23-
| DApps | Information and tutorials for application developers. | `llms-dapps.txt` | [:octicons-copy-16:](){ .llms data-action="copy" data-value="llms-dapps.txt" } [:octicons-download-16:](/llms-files/llms-dapps.txt){ download="llms-dapps.txt" } |
24-
| Networks | Information about the various Polkadot networks (Polkadot, Kusama, Westend, Paseo), their purposes, and how they fit into the development workflow. | `llms-networks.txt` | [:octicons-copy-16:](){ .llms data-action="copy" data-value="llms-networks.txt" } [:octicons-download-16:](/llms-files/llms-networks.txt){ download="llms-networks.txt" } |
25-
| Polkadot Protocol | Polkadot's core architecture, including the relay chain, parachains, system chains, interoperability, and main actors. | `llms-polkadot-protocol.txt` | [:octicons-copy-16:](){ .llms data-action="copy" data-value="llms-polkadot-protocol.txt" } [:octicons-download-16:](/llms-files/llms-polkadot-protocol.txt){ download="llms-polkadot-protocol.txt" } |
26-
| Infrastructure | Operational aspects of supporting the Polkadot network including how to run a node or validator and staking mechanics. | `llms-infrastructure.txt` | [:octicons-copy-16:](){ .llms data-action="copy" data-value="llms-infrastructure.txt" } [:octicons-download-16:](/llms-files/llms-infrastructure.txt){ download="llms-infrastructure.txt" } |
27-
| Tooling | An overview of various development tools available for Polkadot development. | `llms-tooling.txt` | [:octicons-copy-16:](){ .llms data-action="copy" data-value="llms-tooling.txt" } [:octicons-download-16:](/llms-files/llms-tooling.txt){ download="llms-tooling.txt" } |
22+
| Category | Description | File | Actions |
23+
|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
24+
| Index | Markdown URL index for documentation pages, links to essential repos, and additional resources in the llms.txt standard format. | <code style="white-space: nowrap;">llms.txt</code> | [:octicons-copy-16:](){ .llms-copy data-path="/llms.txt" } [:octicons-download-16:](){ .llms-dl data-path="/llms.txt" data-filename="llms.txt" } |
25+
| Site index (JSON) | Lightweight site index of JSON objects (one per page) with metadata and content previews. | <code style="white-space: nowrap;">site-index.json</code> | [:octicons-copy-16:](){ .llms-copy data-path="/ai/site-index.json" } [:octicons-download-16:](){ .llms-dl data-path="/ai/site-index.json" data-filename="site-index.json" } |
26+
| Full site contents (JSONL) | Full content of documentation site enhanced with metadata. | <code style="white-space: nowrap;">llms-full.jsonl</code> | [:octicons-copy-16:](){ .llms-copy data-path="/llms-full.jsonl" } [:octicons-download-16:](){ .llms-dl data-path="/llms-full.jsonl" data-filename="llms-full.jsonl" } |
27+
| Basics | Polkadot general knowledge base to provide context around overview and beginner-level content. | <code style="white-space: nowrap;">basics.md</code> | [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/basics.md" } [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/basics.md" data-filename="basics.md" } |
28+
| Reference | Reference material including key functions and glossary. | <code style="white-space: nowrap;">reference.md</code> | [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/reference.md" } [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/reference.md" data-filename="reference.md" } |
29+
| Smart Contracts | How to develop and deploy Solidity smart contracts on Polkadot Hub. | <code style="white-space: nowrap;">smart-contracts.md</code> | [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/smart-contracts.md" } [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/smart-contracts.md" data-filename="smart-contracts.md" } |
30+
| Parachains | How-to guides related to building, customizing, deploying, and maintaining a parachain. | <code style="white-space: nowrap;">parachains.md</code> | [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/parachains.md" } [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/parachains.md" data-filename="parachains.md" } |
31+
| DApps | Information and tutorials for application developers. | <code style="white-space: nowrap;">dapps.md</code> | [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/dapps.md" } [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/dapps.md" data-filename="dapps.md" } |
32+
| Networks | Information about the various Polkadot networks (Polkadot, Kusama, Westend, Paseo), their purposes, and how they fit into the development workflow. | <code style="white-space: nowrap;">networks.md</code> | [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/networks.md" } [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/networks.md" data-filename="networks.md" } |
33+
| Polkadot Protocol | Polkadot's core architecture, including the relay chain, parachains, system chains, interoperability, and main actors. | <code style="white-space: nowrap;">polkadot-protocol.md</code> | [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/polkadot-protocol.md" } [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/polkadot-protocol.md" data-filename="polkadot-protocol.md" } |
34+
| Infrastructure | Operational aspects of supporting the Polkadot network, including how to run a node or validator and staking mechanics. | <code style="white-space: nowrap;">infrastructure.md</code> | [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/infrastructure.md" } [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/infrastructure.md" data-filename="infrastructure.md" } |
35+
| Tooling | An overview of various development tools available for Polkadot development. | <code style="white-space: nowrap;">tooling.md</code> | [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/tooling.md" } [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/tooling.md" data-filename="tooling.md" } |
2836

2937
!!! note
30-
The `llms-full.txt` file may exceed the input limits of some language models due to its size. If you encounter limitations, consider using the files by category.
38+
The `llms-full.jsonl` file may exceed the input limits of some language models due to its size. If you encounter limitations, consider using the smaller `site-index.json` or category bundle files instead.

0 commit comments

Comments
 (0)