[WIP] Prepare LLMs files#2169
Open
serg wants to merge 13 commits intokubermatic:mainfrom
Open
Conversation
Signed-off-by: serg <contact@sergfurtak.com>
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Signed-off-by: serg <contact@sergfurtak.com>
…t for md version of the page Signed-off-by: serg <contact@sergfurtak.com>
…e CHANGELOG-<RELEASE>.md part Signed-off-by: serg <contact@sergfurtak.com>
Signed-off-by: serg <contact@sergfurtak.com>
Signed-off-by: serg <contact@sergfurtak.com>
Signed-off-by: serg <contact@sergfurtak.com>
Signed-off-by: serg <contact@sergfurtak.com>
Signed-off-by: serg <contact@sergfurtak.com>
Signed-off-by: serg <contact@sergfurtak.com>
Signed-off-by: serg <contact@sergfurtak.com>
Signed-off-by: serg <contact@sergfurtak.com>
Signed-off-by: serg <contact@sergfurtak.com>
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
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.
/hold
Making the docs site AI agent-friendly
1.
llms.txtimprovementsThe
llms.txtindex files had HTML entities scattered throughout ("instead of“,>instead of>, etc.), making content hard to read for agents. Added a decode-entities template helper that cleans up all of these automatically.Added
/.well-known/llms.txtas an alternative discovery path (some agent frameworks check there), served as a transparent rewrite from/llms.txt.Improved the homepage
llms.txtto show a brief description of each product pulled fromproducts.yaml, so agents immediately understand what each product is about. Only last version is included for the products.llms.txt/llms-full.txt— follows the llmstxt.org standard. It’s a curated index for LLMs to discover what documentation exists. The homepage/llms.txtlists all products; section-level/llms.txtfiles list pages;/llms-full.txtfiles concatenate entire sections into one file for bulk ingestion. These are purpose-built for offline/batch use — an AI agent that wants to understand the whole KKP docs would fetch/llms-full.txtonce and process it.2. Markdown for Agents (per-page content negotiation)
Implemented the Cloudflare Markdown for Agents standard. Hugo now generates an
index.mdalongside everyindex.html— 4,700+ pages across all products. When an AI agent sendsAccept: text/markdownin its request, a Netlify Edge Function intercepts it and returns the markdown version with the correctContent-Type: text/markdownandx-markdown-tokensheaders, rather than HTML.Pages marked as
sitemapexcludeor with empty content are skipped (the edge function falls through to the normal HTML response).3. Discovery headers
Added
Linkresponse headers on the homepage pointing agents to/llms.txt,/sitemap.xmland/search.json— following RFC 8288, which is what isitagentready.com checks for.4. Build fix
The Netlify build was failing because a
{{< render_external_markdown >}}shortcode in themainbranch used a placeholder URL (CHANGELOG-<RELEASE>.md) that was never substituted. Changed the error from fatal (errorf) to a warning (warnf) so the build continues instead of aborting.