Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the docs content for the AI Resources page to support an external “AI Resources Page” MkDocs plugin by removing the manually maintained page body, leaving only frontmatter metadata.
Changes:
- Removed all existing AI Resources page content (overview, usage instructions, download/actions table, and note).
- Left only YAML frontmatter (
title/description) inai-resources.md.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| !!! 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. | ||
| --- No newline at end of file |
There was a problem hiding this comment.
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.
| --- | |
| --- | |
| # 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. |
There was a problem hiding this comment.
@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!
Requires these PRs to work:
mkdocs-plugins: papermoonio/mkdocs-plugins#8
polkadot-mkdocs: papermoonio/polkadot-mkdocs#231
This pull request makes a significant update to the
ai-resources.mdfile by removing all of its content. The file previously provided documentation and download links for Polkadot's AI-optimized resources, including descriptions, usage instructions, and a table of downloadable files.Content removal:
llms.txt,site-index.json,llms-full.jsonl, and category-specific files).llms-full.jsonlfile and suggested alternatives for smaller context windows.Merging these changes (and related PRs) will result in the programmatic generation of the AI Resources page by the ai-resources-page plugin.