Skip to content

Commit b7ed247

Browse files
committed
moved ai agents isssue to a recommendation
Signed-off-by: Bruce Hamilton <scarlettbernique@gmail.com>
1 parent 0e0247a commit b7ed247

2 files changed

Lines changed: 12 additions & 22 deletions

File tree

analyses/2026/flatcar/analysis.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -430,6 +430,18 @@ the best arbiters of what changes are appropriate to the project.
430430
common tasks and concepts could be discussed in the overview, leaving the
431431
subtopics with simpler procedures and minimal repetition.
432432

433+
- CNCF suggests that all CNCF doc maintainers run check with this tool that
434+
measures how well AI agents can read, navigate, and use a documentation site
435+
using this tool: https://afdocs.dev/
436+
437+
One of the main ways to improve AI capabilities is by creating an index file
438+
to reside at the root of the repository that contains links to key sections,
439+
essentially a high level index. AI agents look for this file to navigate the
440+
site.
441+
442+
Visit https://llmstxt.org to learn about the index file. Consult with the
443+
Flatcar team to determine key sections and check in the file.
444+
433445
#### Content maintainability and site mechanics
434446

435447
- Edit each procedural topic into a formal How-to topic with numbered steps.

analyses/2026/flatcar/issues.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -251,28 +251,6 @@ list of common content types that apply to most files:
251251
- explanation
252252
- reference
253253

254-
## Add indexing file to repository to assist AI agents
255-
256-
The CTO of CNCF just suggested that all CNCF doc maintainers run check with this
257-
tool that measures how well AI agents can read, navigate, and use a
258-
documentation site using this tool: https://afdocs.dev/
259-
260-
One of the main ways to improve AI capabilities is by creating an index file to
261-
reside at the root of the repository that contains links to key sections,
262-
essentially a high level index. AI agents look for this file to navigate the
263-
site.
264-
265-
### Context
266-
267-
This issue tracks recommended changes resulting from an analysis of the Flatcar
268-
documentation commissioned by CNCF. The analysis and supporting documents are
269-
here: https://github.com/cncf/techdocs/tree/main/analyses under `2026/Flatcar`.
270-
271-
### Possible Implementation
272-
273-
Visit https://llmstxt.org to learn about the index file. Consult with the
274-
Flatcar team to determine key sections and check in the file.
275-
276254
## Consolidate Concepts in Virtual Machines Overview
277255

278256
### Overview

0 commit comments

Comments
 (0)