Skip to content

Integrates AI Resources Page plugin #1485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
dawnkelly09 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Integrates AI Resources Page plugin #1485

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 1 addition & 34 deletions ai-resources.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,37 +1,4 @@
---
title: AI Resources
description: Download LLM-optimized files of the Polkadot documentation, including full content and category-specific resources for AI agents.
---

# AI Resources

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.

## How to Use These Files

- **Quick navigation**: Use `llms.txt` to give models a high-level map of the site.
- **Lightweight context**: Use `site-index.json` for smaller context windows or when you only need targeted retrieval.
- **Full content**: Use `llms-full.jsonl` for large-context models or preparing data for RAG pipelines.
- **Focused bundles**: Use category files (e.g., `basics.md`, `parachains.md`) to limit content to a specific theme or task for more focused responses.

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.

## Access LLM Files

| Category | Description | File | Actions |
|----------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 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> | <div class="actions"> [:octicons-eye-16:](){ .llms-view data-path="/llms.txt" title="View"} [:octicons-copy-16:](){ .llms-copy data-path="/llms.txt" title="Copy"} [:octicons-download-16:](){ .llms-dl data-path="/llms.txt" data-filename="llms.txt" title="Download"} </div> |
| 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> | <div class="actions"> [:octicons-eye-16:](){ .llms-view data-path="/ai/site-index.json" title="View"} [:octicons-copy-16:](){ .llms-copy data-path="/ai/site-index.json" title="Copy"} [:octicons-download-16:](){ .llms-dl data-path="/ai/site-index.json" data-filename="site-index.json" title="Download"} </div> |
| Full site contents (JSONL) | Full content of documentation site enhanced with metadata. | <code style="white-space: nowrap;">llms-full.jsonl</code> | <div class="actions"> [:octicons-copy-16:](){ .llms-copy data-path="/ai/llms-full.jsonl" title="Copy" } [:octicons-download-16:](){ .llms-dl data-path="/ai/llms-full.jsonl" data-filename="llms-full.jsonl" title="Download" } </div> |
| Basics | Polkadot general knowledge base to provide context around overview and beginner-level content. | <code style="white-space: nowrap;">basics.md</code> | <div class="actions"> [:octicons-eye-16:](){ .llms-view data-path="/ai/categories/basics.md" title="View"} [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/basics.md" title="Copy"} [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/basics.md" data-filename="basics.md" title="Download"} </div> |
| Reference | Reference material including key functions and glossary. | <code style="white-space: nowrap;">reference.md</code> | <div class="actions"> [:octicons-eye-16:](){ .llms-view data-path="/ai/categories/reference.md" title="View"} [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/reference.md" title="Copy"} [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/reference.md" data-filename="reference.md" title="Download"} </div> |
| Smart Contracts | How to develop and deploy Solidity smart contracts on Polkadot Hub. | <code style="white-space: nowrap;">smart-contracts.md</code> | <div class="actions"> [:octicons-eye-16:](){ .llms-view data-path="/ai/categories/smart-contracts.md" title="View"} [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/smart-contracts.md" title="Copy"} [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/smart-contracts.md" data-filename="smart-contracts.md" title="Download"} </div> |
| Parachains | How-to guides related to building, customizing, deploying, and maintaining a parachain. | <code style="white-space: nowrap;">parachains.md</code> | <div class="actions"> [:octicons-eye-16:](){ .llms-view data-path="/ai/categories/parachains.md" title="View"} [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/parachains.md" title="Copy"} [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/parachains.md" data-filename="parachains.md" title="Download"} </div> |
| DApps | Information and tutorials for application developers. | <code style="white-space: nowrap;">dapps.md</code> | <div class="actions"> [:octicons-eye-16:](){ .llms-view data-path="/ai/categories/dapps.md" title="View"} [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/dapps.md" title="Copy"} [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/dapps.md" data-filename="dapps.md" title="Download"} </div> |
| 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> | <div class="actions"> [:octicons-eye-16:](){ .llms-view data-path="/ai/categories/networks.md" title="View"} [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/networks.md" title="Copy"} [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/networks.md" data-filename="networks.md" title="Download"} </div> |
| 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> | <div class="actions"> [:octicons-eye-16:](){ .llms-view data-path="/ai/categories/polkadot-protocol.md" title="View"} [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/polkadot-protocol.md" title="Copy"} [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/polkadot-protocol.md" data-filename="polkadot-protocol.md" title="Download"} </div> |
| 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> | <div class="actions"> [:octicons-eye-16:](){ .llms-view data-path="/ai/categories/infrastructure.md" title="View"} [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/infrastructure.md" title="Copy"} [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/infrastructure.md" data-filename="infrastructure.md" title="Download"} </div> |
| Tooling | An overview of various development tools available for Polkadot development. | <code style="white-space: nowrap;">tooling.md</code> | <div class="actions"> [:octicons-eye-16:](){ .llms-view data-path="/ai/categories/tooling.md" title="View"} [:octicons-copy-16:](){ .llms-copy data-path="/ai/categories/tooling.md" title="Copy"} [:octicons-download-16:](){ .llms-dl data-path="/ai/categories/tooling.md" data-filename="tooling.md" title="Download"} </div> |

!!! note
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.
---
Copy link

Copilot AI Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ai-resources.md now contains only frontmatter, so the rendered “AI Resources” page will be blank unless the external MkDocs plugin injects content at build time. To avoid an empty page in local builds / previews (or if the plugin is disabled/misconfigured), add a minimal fallback body (e.g., a short note that the content is generated at build time and where to find the files) or include content via a snippet similar to other policy pages.

Suggested change
---
---
# AI Resources
This page lists LLM-ready exports of the Polkadot documentation that can be used by AI agents and tools.
In the full site build, the detailed download links and file list are generated automatically at build time by the documentation tooling.
If you are viewing this page in a local preview and do not see any generated content:
- Ensure that the MkDocs build plugins for AI resources are enabled and configured.
- Check the repository’s documentation or `docs/` subdirectories for the raw AI resource files and generation scripts.
Once the build-time generation step is working correctly, this page will be populated with the full set of AI resource links.

Copilot uses AI. Check for mistakes.
Copy link
Collaborator Author

@dawnkelly09 dawnkelly09 Feb 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@eshaben In local testing, the page generated by the plugin does overwrite any "fallback" content. If I remove the plugin from mkdocs.yml, it then displays the fallback content. Please confirm if we want to use a fallback page (I think yes but maybe you have a different idea for handling this). If we do want a fallback, what should be on that page? Thank you!

Loading