Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@tjaffri
Copy link
Contributor

@tjaffri tjaffri commented Oct 28, 2025

Summary

Adds llms.txt support to the UiPath Python SDK documentation using the mkdocs-llmstxt plugin, providing a standards-compliant, LLM-friendly documentation index.

Changes

  • ✅ Added mkdocs-llmstxt>=0.1.0 to dev dependencies
  • ✅ Configured llmstxt plugin in mkdocs.yml with organized sections
  • ✅ Uses glob patterns (core/*.md, cli/*.md, etc.) to auto-discover documentation
  • ✅ Generates compact 1.7KB index with links (follows llmstxt.org standard)
  • ✅ Updated .gitignore to exclude built site/ directory

Solution Details

Instead of creating a custom Python script (as originally proposed in #582), this implementation uses the mkdocs-llmstxt plugin for a simpler, more maintainable approach:

Benefits:

  • 🔄 Automatically generates llms.txt during docs build
  • 📋 Standards-compliant format (index with links, not full content)
  • 🎯 Organized sections mirroring nav structure
  • 🔍 Glob patterns auto-discover new files in existing directories
  • 🚀 Zero-maintenance for files added to existing sections

Generated llms.txt structure:

# UiPath SDK

## UiPath SDK
- [Actions](https://...)
- [Assets](https://...)
- [Getting Started](https://...)
...

## UiPath MCP SDK
## UiPath LangChain SDK
## UiPath LlamaIndex SDK

## Contributing & Resources
- [FAQ](https://...)
- [Automation Suite](https://...)
...

Maintenance: When adding a new SDK/section to nav, add one corresponding line with a glob pattern to the llmstxt config.

Closes #582

🤖 Generated with Claude Code

tjaffri and others added 2 commits October 28, 2025 16:20
- Add mkdocs-llmstxt plugin to generate standards-compliant llms.txt
- Configure organized sections for Core SDK, MCP, LangChain, and LlamaIndex
- Use glob patterns to auto-discover new documentation files
- Generate 1.7KB compact index with links (not full content)
- Update .gitignore to exclude built site/ directory

Fixes UiPath#582

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
- Remove comment from mkdocs.yml llmstxt config
- Remove extra blank line from .gitignore
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add llms.txt for LLM-friendly documentation

2 participants