feat(seo): add agent instructions to auto-generated llms.txt via docs… - #808
Open
am-hernandez wants to merge 4 commits into
Open
feat(seo): add agent instructions to auto-generated llms.txt via docs…#808am-hernandez wants to merge 4 commits into
am-hernandez wants to merge 4 commits into
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
… and agent instructions
…ame page for MCP discoverability
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a
markdown.instructionsblock todocs.json. Mintlify renders it as an"Agent Instructions" blockquote at the top of the auto-generated
llms.txt,llms-full.txt, and every page's.mdexport. The block covers three things:what Turnkey is and its best-fit use cases, how API calls are authenticated,
and the key developer resources named explicitly (API reference, OpenAPI spec,
authentication, webhooks, MCP server, agent skills, CLI, SDK reference,
llms-full.txt).
Why
Addresses item 11 (and part of 13) of the AI visibility review in CUS-325,
spun off from MKT-2472: agents searching for Turnkey developer resources
could not find them from llms.txt. Using
docs.jsonkeeps llms.txt fullyauto-generated by Mintlify; no manually maintained file to drift.
Non-goals
The remaining review items (when-to-use guidance on About Turnkey, product
name in page titles, MCP install link fixes) land separately.
Testing
docs.jsonvalidates as JSON;mintlify devrenders normally.llms.txtand.mdexports are only generated by Mintlify hosting, soverify on the preview deployment: check
<preview-url>/llms.txtfor theAgent Instructions block and
<preview-url>/welcome.mdfor how it readson page exports.
Ticket
Closes CUS-325