Repository navigation
Publish markdown copies of docs pages plus llms.txt and llms-full.txt - #17
Closed
alechollingsworth-engine wants to merge 1 commit into
Closed
alechollingsworth-engine wants to merge 1 commit into
alechollingsworth-engine wants to merge 1 commit into
Conversation
Adds a writeLlmsFiles task that runs after buildSite and writes, from the staged Jekyll content: - a plain markdown copy of each page at the same path with .md (/webhooks.html -> /webhooks.md, / -> /index.md) - llms.txt (https://llmstxt.org) indexing every page in nav order plus the OpenAPI spec and proto downloads - llms-full.txt with every page concatenated Kramdown-only syntax (TOC blocks, attribute lists, lint directives) is stripped, unused reference link definitions are dropped, and site-relative links are made absolute. Each markdown-sourced HTML page gets a <link rel="alternate" type="text/markdown"> to its .md copy. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Author
|
Closing: changes should be proposed in the staging repo instead. Will reopen there. |
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.
What
Makes the docs easy for LLMs and AI agents to read. After
buildSite, a new Gradle task (writeLlmsFiles) writes intobuild/dist/site:.md(/webhooks.html->/webhooks.md,/->/index.md). 23 pages, including the generated gRPC reference.llms.txt(llmstxt.org): every page in sidebar order, plus links to the OpenAPI spec and proto zip.llms-full.txt: all pages concatenated in nav order.<link rel="alternate" type="text/markdown">on each markdown-sourced HTML page, plus a link tollms.txt(head_custom.html).How
build/staging/site/content), so the markdown matches what Jekyll renders. Lives inbuildSrc/src/main/kotlin/LlmsFiles.ktbecause the github-pages gem runs Jekyll in safe mode (no custom plugins).{: ...}attribute lists, markdownlint directives), drops unused reference-link definitions from the shared footer, and makes site-relative links absolute.https://engine-public.github.io/engine-partner-api(override withJEKYLL_SITE_URL).omni-docs-reverse-proxyalready rewritestext/*bodies, so they come out ashttps://omni.engine.com/docs/...in production.llms.txtheader copy lives insrc/main/markdown/templates/_llms_header.md(underscore = not staged as a page) so the team can edit it.Tested
./gradlew buildSite(ENGINE_BUILD_VERSION=2.5.0, JEKYLL_BASE_URL=/engine-partner-api) in Docker: 23.mdfiles,llms.txt,llms-full.txtgenerated; everyrel="alternate"link resolves to a generated file; no leftover kramdown syntax../gradlew build(needs the Corretto 21 toolchain); CI covers it.Why
Part of making the Omni docs at omni.engine.com/docs readable by AI assistants and agents (Growth/AEO). Follow-ups planned separately: per-page meta descriptions, intros on the section landing pages, readable gRPC page titles.
I don't have write access to this repo yet (IT ticket pending), so this comes from a fork. Would appreciate a review from whoever maintains the docs build.
🤖 Generated with Claude Code