Skip to content

website: add machine-readable documentation index (llms.txt)#4350

Open
Sridhar1030 wants to merge 2 commits intokubeflow:masterfrom
Sridhar1030:feature/llms-txt
Open

website: add machine-readable documentation index (llms.txt)#4350
Sridhar1030 wants to merge 2 commits intokubeflow:masterfrom
Sridhar1030:feature/llms-txt

Conversation

@Sridhar1030
Copy link
Copy Markdown
Contributor

Description of Changes

Introduce llms.txt and llms-full.txt as Hugo custom output formats following the
llmstxt.org standard, providing a machine-readable documentation
index for LLM consumption.

What's included:

  • llms.txt — curated index of all docs pages with titles, URLs, and descriptions
  • llms-full.txt — expanded version with full inline page content for RAG pipelines
  • Both files auto-regenerate on every Hugo build (including live reload during development)
  • Legacy (v1) docs are separated into an "Optional" section per the llms.txt spec

Files changed:

  • config.toml — added LLMS and LLMSFull custom output formats
  • layouts/index.llms.txt — template for /llms.txt
  • layouts/index.llmsfull.txt — template for /llms-full.txt
  • layouts/partials/llms-pages.html — recursive partial for curated index
  • layouts/partials/llms-full-pages.html — recursive partial for full content

Results
image
image
image

Related Issues

Closes: #4349

Checklist

Add llms.txt and llms-full.txt as Hugo custom output formats that
auto-generate on every build, following the llmstxt.org standard.
Closes kubeflow#4349

Signed-off-by: Sridhar1030 <sridharpillai75@gmail.com>
@google-oss-prow
Copy link
Copy Markdown

Hi @Sridhar1030. Thanks for your PR.

I'm waiting for a kubeflow member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@google-oss-prow google-oss-prow bot added area/website AREA: Website Styles/Hosting/Serving size/L labels Mar 23, 2026
@google-oss-prow
Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign johnugeorge for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@github-actions
Copy link
Copy Markdown

🚫 This command cannot be processed. Only organization members or owners can use the commands.

Signed-off-by: Sridhar1030 <sridharpillai75@gmail.com>
@Sridhar1030 Sridhar1030 changed the title feat(docs): add machine-readable documentation index (llms.txt) website: add machine-readable documentation index (llms.txt) Mar 23, 2026
Copy link
Copy Markdown
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/ok-to-test

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/website AREA: Website Styles/Hosting/Serving ok-to-test size/L

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feature(docs): add machine-readable documentation index (llm.txt)

2 participants