Skip to content

site: publish per-page Markdown and fix llms.txt and llms-full.txt - #3435

Merged
Benjamin Elder (BenTheElder) merged 3 commits into
agent-substrate:mainfrom
moficodes:llms-txt
Oct 30, 2026
Merged

Benjamin Elder (BenTheElder) merged 3 commits into
agent-substrate:mainfrom
moficodes:llms-txt

Conversation

@moficodes

@moficodes Mofi Rahman (moficodes) commented Oct 29, 2026 •

Copy link
Copy Markdown
Collaborator

ate.dev/llms.txt linked to full Docsy HTML pages instead of standalone Markdown files, omitted page status markers and schema links, and still used the old ateom component name. Meanwhile, raw-markdown.html wrote into an HTML template buffer and expanded include-file with replaceRE, which HTML-escaped code blocks and blockquotes across ate.dev/llms-full.txt and "Copy as Markdown" (&#39;, &#34;, &gt;), stripped $VAR shell references as regexp capture groups, left relative links unrewritten, and kept decorative <figure> HTML blocks.

  • Add the MARKDOWN output format for doc pages (site/layouts/docs/single.md) so each page publishes a clean index.md alongside index.html and exposes <link rel="alternate" type="text/markdown"> in <head>.
  • Return a plain string from raw-markdown.html, expand include-file with literal replacement, drop decorative diagram HTML, and rewrite relative links to absolute URLs across llms-full.txt, per-page index.md, and "Copy as Markdown".
  • Update index.llms.txt to link to each page's index.md build, include [Status: ...] labels from front matter, link the ateapi.proto, ate.dev/v1 CRD, and OpenTelemetry Weaver metric schemas, and summarize the sandbox model and the split between ate.dev/v1 Kubernetes CRDs and the ate-api-server gRPC API.
  • Replace leftover ateom, ate-api, and herder references in docs with ateworker, atenet-router, and ate-api-server, and add template tests in hack/test-site-templates.sh.

AI use: AI-assisted, I reviewed and tested it.

  • Tests pass
  • Docs updated

raw-markdown.html wrote to an HTML template buffer and expanded
include-file with replaceRE. That HTML-escaped code blocks and
blockquotes in llms-full.txt and "Copy as Markdown", and stripped $VAR
shell references as regexp capture groups. Return a plain string,
replace include-file literally, drop decorative diagram HTML, and
rewrite relative links to absolute URLs across llms-full.txt, "Copy as
Markdown", and the new per-page index.md output format.

Update llms.txt to link to each page's index.md build, include page
status tags, link the protobuf, CRD, and metric schemas, and summarize
the sandbox model and the split between ate.dev/v1 CRDs and the
ate-api-server gRPC API. Replace leftover ateom and ate-api references
with ateworker, atenet-router, and ate-api-server.

Signed-off-by: Mofi Rahman <[email protected]>
@moficodes Mofi Rahman (moficodes) added the kind/docs Improvements or additions to documentation label Oct 29, 2026
Remove leftover references to the retired "herder" term from the
overview diagram, architecture guide, and WorkerPool API documentation.

Signed-off-by: Mofi Rahman <[email protected]>
Link kind to https://kind.sigs.k8s.io/ in the overview and quickstart
pages, and use lowercase kind consistently there and on the 404 card.

Signed-off-by: Mofi Rahman <[email protected]>
@BenTheElder
Benjamin Elder (BenTheElder) added this pull request to the merge queue Oct 30, 2026
Merged via the queue into agent-substrate:main with commit 61ea6c6 Oct 30, 2026
7 checks passed
Dmitry Berkovich (dberkov) pushed a commit that referenced this pull request Nov 2, 2026
…3435)

`ate.dev/llms.txt` linked to full Docsy HTML pages instead of standalone
Markdown files, omitted page status markers and schema links, and still
used the old `ateom` component name. Meanwhile, `raw-markdown.html`
wrote into an HTML template buffer and expanded `include-file` with
`replaceRE`, which HTML-escaped code blocks and blockquotes across
`ate.dev/llms-full.txt` and "Copy as Markdown" (`&#39;`, `&#34;`,
`&gt;`), stripped `$VAR` shell references as regexp capture groups, left
relative links unrewritten, and kept decorative `<figure>` HTML blocks.

- Add the `MARKDOWN` output format for doc pages
(`site/layouts/docs/single.md`) so each page publishes a clean
`index.md` alongside `index.html` and exposes `<link rel="alternate"
type="text/markdown">` in `<head>`.
- Return a plain string from `raw-markdown.html`, expand `include-file`
with literal replacement, drop decorative diagram HTML, and rewrite
relative links to absolute URLs across `llms-full.txt`, per-page
`index.md`, and "Copy as Markdown".
- Update `index.llms.txt` to link to each page's `index.md` build,
include `[Status: ...]` labels from front matter, link the
`ateapi.proto`, `ate.dev/v1` CRD, and OpenTelemetry Weaver metric
schemas, and summarize the sandbox model and the split between
`ate.dev/v1` Kubernetes CRDs and the `ate-api-server` gRPC API.
- Replace leftover `ateom`, `ate-api`, and `herder` references in docs
with `ateworker`, `atenet-router`, and `ate-api-server`, and add
template tests in `hack/test-site-templates.sh`.

AI use: AI-assisted, I reviewed and tested it.

- [x] Tests pass
- [x] Docs updated

---------

Signed-off-by: Mofi Rahman <[email protected]>
(cherry picked from commit 61ea6c6)
Signed-off-by: Eitan Yarmush <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants