Add Gaffer section to llms.txt#967
Merged
George-Payne merged 1 commit intoJun 4, 2026
Merged
Conversation
Docs build
|
Contributor
Review Summary by QodoAdd Gaffer section to llms.txt documentation index
WalkthroughsDescription• Adds Gaffer section to curated llms.txt for AI tool discovery • Points to Gaffer's own llms.txt and key documentation pages • Gaffer is separate Astro/Starlight site with external URLs • Defers to Gaffer's own index to avoid content duplication Diagramflowchart LR
llmsConfig["llms.ts config"] -- "adds gaffer getter" --> gafferGetter["gaffer TemplateGetter"]
gafferGetter -- "returns markdown links" --> gafferLinks["External Gaffer URLs"]
llmsConfig -- "registers in template" --> llmsTemplate["llms.txt template"]
llmsTemplate -- "includes gaffer section" --> output["Curated llms.txt output"]
File Changes1. docs/.vuepress/configs/llms.ts
|
Contributor
Code Review by Qodo
Context used 1. Outdated section-order comment
|
Deploying documentation with
|
| Latest commit: |
742ddcb
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://2d69b23e.documentation-21k.pages.dev |
| Branch Preview URL: | https://george-ui-1633-make-gaffer-d.documentation-21k.pages.dev |
Docs build
|
George-Payne
added a commit
to kurrent-io/gaffer
that referenced
this pull request
Jun 4, 2026
Adds the [`starlight-llms-txt`](https://github.com/delucis/starlight-llms-txt) plugin to the gaffer docs site so it generates its own `llms.txt` (curated index), `llms-full.txt` (complete docs in one file), and `llms-small.txt` (abridged). docs.kurrent.io cross-links to gaffer's own AI index rather than duplicating gaffer's page list, so gaffer owns and maintains its index from its real page tree. see: kurrent-io/documentation#967
George-Payne
force-pushed
the
george/ui-1633-make-gaffer-discoverable-via-llmstxt-docs-section
branch
from
17e7b80 to
6967fb4
Compare
- Add a `## Gaffer` section to the curated llms.txt, peer to Client Libraries - Points LLM tooling at gaffer's own llms.txt / llms-full.txt plus key pages Gaffer is a separate Astro/Starlight site, so the section references external gaffer.kurrent.io URLs and defers to gaffer's own AI index rather than duplicating its page list (UI-1633).
George-Payne
force-pushed
the
george/ui-1633-make-gaffer-discoverable-via-llmstxt-docs-section
branch
from
6967fb4 to
742ddcb
Compare
Docs Preview
|
stktung
approved these changes
Jun 4, 2026
Docs build
|
George-Payne
deleted the
george/ui-1633-make-gaffer-discoverable-via-llmstxt-docs-section
branch
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
2 participants
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.
Adds a
## Gaffer (Projection Development Toolkit)section to the curatedllms.txt(docs/.vuepress/configs/llms.ts), peer to Client Libraries / Cloud.Gaffer is a separate Astro/Starlight site (
gaffer.kurrent.io), so the section is a static list of external links. It leads with a pointer to gaffer's ownllms.txt/llms-full.txtso tooling can fetch gaffer's full machine-readable index, plus a few key human-facing pages.see: kurrent-io/gaffer#138