Conversation
- Add sphinx-llm extension to generate llms.txt and llms-full.txt following the llmstxt.org standard for AI-consumable docs - Create custom sphinx_json_index extension for structured JSON metadata with page titles, paths, and navigation hierarchy - Update CI workflow to verify AI outputs are generated - Update Python version requirement to >=3.12,<3.14 - Fix sphinx_design_elements git reference 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
📖 Documentation Preview✅ Preview is live! Built from commit b14aa11 |
📚 Documentation ReviewLet me output the review directly to you: SummaryThe ChipFlow documentation is well-structured and comprehensive, but contains several critical command inconsistencies between different guides that would prevent users from successfully following tutorials. Issues FoundCritical
Major
Minor
RecommendationsTop 5 Actionable Improvements
This review was automatically generated by Claude Code |
- Add <script type="text/llms.txt"> to HTML pages for inline discovery (following Vercel's proposal for LLM instructions in HTML) - Reorganize llms.txt into logical sections: - Getting Started, User Guide, API Reference - Digital IP Library, Amaranth Language, Amaranth SoC - Optional (changelog, support) - Configurable section mappings via llms_sections config option 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
📖 Documentation Preview✅ Preview is live! Built from commit 4ed1ad5 |
Summary
Add AI-friendly documentation outputs to make docs easily consumable by AI agents:
Changes
sphinx-llmextension for llms.txt generationsphinx_json_indexSphinx extension for JSON index>=3.12,<3.14sphinx_design_elementsgit referenceTest plan
llms.txt,llms-full.txt, anddocs-index.jsonare generated in build output🤖 Generated with Claude Code