Upsun Docs is Now llms.txt compatible!
We’re thrilled to announce that Upsun Documentation is now fully compatible with llms.txt proposed standard!
This update brings enhanced integrations, better automation, and more flexibility to your documentation workflows.
What is llms.txt and why does it matter?
With the growing enthusiasm for AI, many folks are looking for AI-powered assistants to provide technical information about certain products.
After years of remarkable achievements through web 2.0 and its famous robots.txt
, security.txt
, and humans.txt
,
a new standard has been proposed to the web ecosystem and will soon become essential for the web: llms.txt
.
llms.txt
was conceived by Jeremy Howard, co-founder of Answer.AI, to address a fundamental challenge in AI-human interaction.
When AI assistants attempt to process standard web pages, they struggle with non-essential elements like navigation menus, scripts, and styling.
These elements consume valuable contextual space without contributing to an actual understanding of the content from the AIs perspective.
llms.txt
provides an elegant solution by delivering precisely curated information in a format that AI systems can efficiently process.
By making llms.txt
and llms-full.txt
files publicly available, AI Assistants will now be able to easily parse documentation and ingest technical information about a product to help your end users understand how to use it.
Upsun Docs is now llms.txt
-compatible
Upsun Docs is now llms.txt
-compatible, thanks to the public availability of the llms.txt and llms-full.txt files.
These two files can be fed into external LLMs or AI assistants to accurately parse Upsun Docs content.
Additionally, every documentation page is now available in Markdown format, with an added View Markdown version button on the right menu of each page.
This allows users to easily access and export the raw Markdown format for their own needs.
What’s new in Upsun Docs?
With llms.txt
compatibility, Upsun Docs introduces:
- Seamless integration with AI Assistants: LLMs compatibility allows AI tools to interact with Upsun Docs more efficiently.
- Content structuring for learning systems: The use of Upsun Docs within an LMS environment will guarantee a smoother, more structured experience.
- Markdown export for every page: Easily download and reuse documentation content with a dedicated Markdown version button.
How llms.txt
benefits you
Whether you’re a developer, technical writer, or enterprise team, llms.txt
compatibility enhances your documentation experience:
For Developers
- Train your AI Helper with
llms.txt
andllms-full.txt
to improve your Upsun experience. - Enable real-time content updates within your ecosystem.
For Technical Writers
- Simplify content structuring for better readability and navigation.
- Optimize searchability with improved metadata indexing.
- Export Markdown versions easily for documentation portability.
For Teams & Businesses
- Integrate documentation seamlessly with training platforms.
- Enhance collaboration and knowledge sharing across teams.
- Use Markdown for easy integration into wikis and other platforms.
How to get started
Upsun was recently released (at the start of 2024), therefore AI systems like Cursor, ChatGPT, Claude, and Copilot are yet to provide in-depth knowledge about the product. To fix that problem, we’ve provided two LLM-friendly files that teach them how to use Upsun. To use them, add these links to your AI helper:
Transparency vs. AI Scraping: The Upsun approach
Recently, some websites have started implementing “tarpits” to trap AI scrapers that ignore robots.txt
,
as described in this Ars Technica article.
The goal is to prevent unauthorized use of content in AI models by feeding them incorrect data or slowing down their requests.
At Upsun, we take a different approach: instead of completely blocking AI access, we provide a structured and official version of our documentation via llms.txt
proposed standards.
Through the llms.txt
and llms-full.txt
files, AI assistants can access information in a controlled, transparent, and beneficial way for users.
Our goal is to facilitate access to information while maintaining clear and respectful guidelines for data usage. We believe that working with AI should be done within defined rules, rather than through traps or excessive restrictions.
We would love your feedback!
Upsun Docs is now smarter, faster, and more powerful with LLMs integration. Try it today and experience the difference!
👉 Explore the Docs👉 Need Help? Contact Support👉 Join the Discussion:
We’d love to hear how llms.txt
compatibility improves your experience of our product!