Improve llms.txt generation for API-heavy documentation #6148
network-charles
started this conversation in
Bugs & Feedback
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
A new enhancement was released to the generated
llms.txtfile; the page descriptions are truncated to 300 characters.Source: https://www.mintlify.com/docs/ai/llmstxt#llms-txt
While I appreciate the new
llms.txtcharacter limit optimization process, the suggested workaround defeats the purpose of using a managed documentation platform. Many customers chose Mintlify so they could focus on documenting their product rather than maintaining documentation infrastructure. When the auto-generatedllms.txtbecomes unusable due to aggressive truncation, and the sudden alternate recommended solution is to override and curate the file manually, the maintenance burden shifts back to us as customers. At that point, the platform is no longer solving the problem it was intended to solve.This also puts Mintlify customers who have API references in a difficult position, as API documentation naturally consumes a large portion of the available character limit.
A more scalable platform-level solution would be to automatically separate API references into their own generated LLM index (for example,
llms-api.txt) while preserving a high-quality primaryllms.txtfor guides, concepts, and tutorials. However, thellms.txtreferences the customllms-api.txtURL. This would allow customers to continue benefiting from automated generation without taking on the responsibility of manually maintaining LLM-specific documentation files.Another scalable approach is to create a root llms.txt by high-level navigation. For example, the root llms.txt file points to the sub-roots of pages, such as Mintlify tabs or product navigation. The
llms.txtgeneration script can handle this based on if-else conditions.An example of an
llms.txtfile nested by navigation.These suggested design decisions are based on the Agent documentation spec, specifically, the Progressive Disclosure for Large Documentation Sets.
https://agentdocsspec.com/spec/#progressive-disclosure-for-large-documentation-sets
These approaches provide better optionality.
Beta Was this translation helpful? Give feedback.
All reactions