Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
bc3ab22
created basic harness layout
iRaindrop Oct 21, 2026
c4d692b
ran prettier
iRaindrop Oct 21, 2026
5e33820
added missing H1s
iRaindrop Oct 22, 2026
785c922
format edits
iRaindrop Oct 22, 2026
adf6eb7
format fixes
iRaindrop Oct 22, 2026
b194e54
trigger build
iRaindrop Oct 22, 2026
1bdb2a9
claude-fable updates and additions
iRaindrop Oct 23, 2026
f5d8e84
line length fix
iRaindrop Oct 23, 2026
6a4ef0e
added old analyses < 2024 to IgnoreDirs
iRaindrop Oct 23, 2026
ee912af
typo fix
iRaindrop Oct 23, 2026
1dc8f22
Added new area: AI Agent Readiness
iRaindrop Oct 24, 2026
0d629c5
misc fixes
iRaindrop Oct 24, 2026
a2a7eac
ran prettier
iRaindrop Oct 24, 2026
6b2b505
ran prettier
iRaindrop Oct 24, 2026
807f79d
noted claude fable 5.1 was used
iRaindrop Oct 24, 2026
0e12477
ran prettier
iRaindrop Oct 24, 2026
0e25ef2
trigger build - no edits
iRaindrop Oct 24, 2026
a834e7d
trigger build - 503 retry
iRaindrop Oct 24, 2026
9604c87
ai-harness: apply review edits from PR #386
iRaindrop Oct 24, 2026
1f41efc
trigger build - no edits
iRaindrop Oct 24, 2026
b88df41
trigger build - no edits
iRaindrop Oct 24, 2026
f21cba1
trigger build - no edits
iRaindrop Oct 25, 2026
8928b35
removed private .github - not needed for harness
iRaindrop Oct 25, 2026
9991152
changed mode:agent to agent:agent in prompt files
iRaindrop Oct 25, 2026
9f340f7
Merge branch 'main' into ai-harness
iRaindrop Oct 27, 2026
6570667
trigger build - no edits
iRaindrop Oct 27, 2026
2ba709c
trigger build - no edits
iRaindrop Oct 27, 2026
97cec53
Merge branch 'main' into ai-harness
chalin Oct 28, 2026
26f74f0
Update docs/analysis/ai-harness/index.md
iRaindrop Oct 30, 2026
b912091
Update docs/analysis/ai-harness/index.md
iRaindrop Oct 30, 2026
53d4974
Update docs/analysis/ai-harness/_github/copilot-instructions.md
iRaindrop Oct 30, 2026
82d6640
Update docs/analysis/ai-harness/_github/copilot-instructions.md
iRaindrop Oct 30, 2026
f6472b1
Update docs/analysis/ai-harness/_github/copilot-instructions.md
iRaindrop Oct 30, 2026
27a265f
Update docs/analysis/ai-harness/_github/copilot-instructions.md
iRaindrop Oct 30, 2026
9ba63fb
Update docs/analysis/ai-harness/_github/copilot-instructions.md
iRaindrop Oct 30, 2026
b9af4c1
formatting - minor edit
iRaindrop Oct 31, 2026
48cb56d
Update docs/analysis/ai-harness/_github/copilot-instructions.md
iRaindrop Nov 2, 2026
e37fbac
Update docs/analysis/ai-harness/_github/copilot-instructions.md
iRaindrop Nov 2, 2026
8af78e0
ran prettier
iRaindrop Nov 2, 2026
62e0bad
updated ai-readiness questions
iRaindrop Nov 12, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .cspell.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ ignorePaths:
# ignoreRegExpList:
# - CodeBlock
words:
- afdocs
- backstore
- Chalin
- CLOTributor
Expand All @@ -30,6 +31,8 @@ words:
- github
- keda
- knative
- llms
- llmstxt
- kedacore
- krator
- krook
Expand Down
546 changes: 546 additions & 0 deletions docs/analysis/ai-harness/_github/copilot-instructions.md

Large diffs are not rendered by default.

43 changes: 43 additions & 0 deletions docs/analysis/ai-harness/_github/criteria/areas/agent-readiness.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# AI agent readiness - Website and Infrastructure

- Display name: AI Agent Readiness
- File stem: agent-readiness

## Questions

- Does the documentation site publish an `llms.txt` file at the site root or
docs root?
- Does `llms.txt` follow the llmstxt.org structure (H1 title, blockquote
summary, H2 sections of link lists)?
- Do all links in `llms.txt` resolve?
- Do links in `llms.txt` point to Markdown versions of pages?
- Is `llms.txt` generated at build time or otherwise kept in sync with the
published site?
- Do HTML and Markdown pages include a directive near the top pointing agents to
`llms.txt`?
- Is a Markdown version of each page served at the same URL with `.md` appended
or substituted?
- Does the Markdown version of each page contain the same content as the HTML
version?
- Are pages rendered server-side or statically generated rather than assembled
by client-side JavaScript?
- Does the main content of each page start near the top of the response rather
than behind large navigation or script payloads?
- Are pages small enough to avoid truncation in an agent's context window?
- Do tabbed components and code fences serialize cleanly to Markdown?
- Is the documentation publicly reachable without authentication gates?
- Is the documentation reachable without CDN bot challenges?
- Do pages return correct HTTP status codes?
- Do moved pages use standard HTTP redirects?
- Does the project monitor its CLOMonitor "Agent readiness" checks?
- Does the project run `afdocs check` against the site?
- Does the project run agent readiness checks in CI?

## Comment guidance

- Additional instructions: Reference sources for this area are the llms.txt
specification (https://llmstxt.org/), the CLOMonitor agent readiness checks
(https://clomonitor.io/docs/topics/checks/#agent-readiness), and the AFDocs
Agent-Friendly Documentation Spec (https://afdocs.dev/). Where possible,
verify by fetching the live site (`/llms.txt`, a page URL with `.md` appended)
rather than relying on the repository source alone.
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Beginner friendly issue backlog - Contributor Documentation

- Display name: Beginner Friendly Issue Backlog
- File stem: beginner-issue-backlog

## Questions

- Are docs issues well-triaged?
- Is there a clearly marked way for new contributors to make code or
documentation contributions (i.e. a “good first issue” label)?
- Are issues well-documented (i.e., more than just a title)?
- Are issues maintained for staleness?

## Comment guidance

- Additional instructions: None.
15 changes: 15 additions & 0 deletions docs/analysis/ai-harness/_github/criteria/areas/branding-design.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Branding and design - Website and Infrastructure

- Display name: Branding and Design
- File stem: branding-design

## Questions

- Is there an easily recognizable brand for the project (logo + color scheme)
clearly identifiable?
- Is the brand used across the website consistently?
- Is the website’s typography clean and well-suited for reading?

## Comment guidance

- Additional instructions: None.
17 changes: 17 additions & 0 deletions docs/analysis/ai-harness/_github/criteria/areas/case-studies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Case studies - Website and Infrastructure

- Display name: Case Studies
- File stem: case-studies

## Questions

- Are there case studies available for the project and are they documented on
the website?
- Are there user testimonials available?
- Is there an active project blog?
- Are there community talks for the project and are they present on the website?
- Is there a logo wall of users/participating organizations?

## Comment guidance

- Additional instructions: None.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Communication methods documented - Contributor Documentation

- Display name: Communication Methods Documented
- File stem: communication-methods-docd

## Questions

- Is there a Slack/Discord/Discourse/etc. community and is it prominently linked
from your website?
- Is there a direct link to your GitHub organization/repository?
- Are weekly/monthly project meetings documented? Is it clear how someone can
join those meetings?
- Are mailing lists documented?

## Comment guidance

- Additional instructions: None.
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Content creation process - Project Documentation

- Display name: Content Creation Process
- File stem: content-creation-process

## Questions

- Is there a clearly documented (ongoing) contribution process for
documentation?
- Does the code release process account for documentation creation & updates?
- Who reviews and approves documentation pull requests?
- Does the website have a clear owner/maintainer?

## Comment guidance

- Good examples:
- https://github.com/nats-io/nats-site/blob/master/MAINTAINERS.md
- https://thanos.io/tip/contributing/how-to-contribute-to-docs.md
- Additional instructions: None.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Content maintainability - Project Documentation

- Display name: Content Maintainability
- File stem: content-maintainability

## Questions

- Is the documentation searchable?
- Are there plans for localization/internationalization with regards to site
directory structure? Is a localization framework present?
- Is there a clearly documented method for versioning of content?

## Comment guidance

- Good examples:
- https://kubernetes.io/docs/
- Additional instructions: None.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Inclusive language - Project Documentation

- Display name: Inclusive Language
- File stem: inclusive-language

## Questions

- Are there any customer-facing utilities, endpoints, class names, or feature
names that use non-recommended words as documented by the
[Inclusive Naming Initiative](https://inclusivenaming.org) website?
- Does the project use language like "simple", "easy", etc.?

## Comment guidance

- Good examples: None.
- Additional instructions: Focus the comment on any inclusive language concerns
in the documentation.
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Information architecture - Project Documentation

- Display name: Information Architecture
- File stem: information-architecture

## Questions

- Is there high level conceptual content?
- Is the documentation feature complete?
- Are there step-by-step instructions documented for features in tasks and
tutorials?
- Are there any key features that are documented but missing task documentation?
- Is the “happy path” (most common use case) documented?
- Are tasks clearly named according to user goals?
- If the documentation doesn't suffice, is there a clear escalation path for
users needing more help? (FAQ, Troubleshooting)
- If the product exposes an API, is there a complete reference that includes
documented CLIs as applicable?
- Is content up to date and accurate?
- Does the documentation need restructuring?

## Comment guidance

- Good examples:
- https://prometheus.io/docs
- Additional instructions: None.
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Maintenance planning - Website and Infrastructure

- Display name: Maintenance Planning
- File stem: maintenance-planning

## Questions

- Is the website tooling well supported by the community (i.e., Hugo with the
Docsy theme) or commonly used by CNCF projects?
- Is there active cultivating website maintainers from within the community?
- Are site build times reasonable?
- Do site maintainers have adequate permissions?
- Is the website accessible via HTTPS?
- Does HTTP access, if any, redirect to HTTPS?

## Comment guidance

- Additional instructions: None.
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# New contributor getting started content - Contributor Documentation

- Display name: New Contributor Getting Started Content
- File stem: new-contributor

## Questions

- Do you have a community repository or section on your website?
- Is there a document specifically for new contributors/your first contribution?
- Do new users know where to get help?

## Comment guidance

- Additional instructions: None.
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# New user content - Project Documentation

- Display name: New User Content
- File stem: new-user

## Questions

- Is “Getting started” clearly labeled? (e.g “Getting started”, “Installation”,
“First steps”, etc.)
- Is installation documented step-by-step?
- If needed, is guidance provided for multiple operating systems and platforms?
- Do users know where to go after reading the getting started guide?
- Is your new user content clearly discoverable, such as on the documentation
home page?
- Is there sample code or content that can easily be copy-pasted?

## Comment guidance

- Good examples:
- https://falco.org/docs/getting-started/
- Additional instructions: None.
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Project Governance Documentation - Contributor Documentation

- Display name: Project Governance Documentation
- File stem: project-governance

## Questions

- Is project governance clearly documented?

## Comment guidance

- Additional instructions: None.
20 changes: 20 additions & 0 deletions docs/analysis/ai-harness/_github/criteria/areas/seo-analytics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# SEO, analytics, and local site search - Website and Infrastructure

- Display name: SEO, Analytics, and Site Search
- File stem: seo-analytics

## Questions

- Is analytics enabled for the production server?
- Is analytics disabled for all other deploys?
- If project is using Google Analytics, has it migrated to GA4?
- Can Page-not-found (404) reports easily be generated from site analytics?
- Is site indexing supported for the production server, while disabled for
website previews and builds for non-default branches?
- Is local intra-site search available from the website?
- Are the current custodian(s) of the analytics accounts (such as Google CSE)
documented?

## Comment guidance

- Additional instructions: None.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Single source requirement - Website and Infrastructure

- Display name: Single-Source Requirement
- File stem: single-source-requirement

## Questions

- Does the project have a single source for its documentation? If not, is there
a reason?

## Comment guidance

- Additional instructions: None.
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Usability, accessibility and devices - Website and Infrastructure

- Display name: Usability, Accessibility and Devices
- File stem: usability-accessibility-devices

## Questions

- Is the website usable from mobile?
- Are doc pages readable?
- Are all / most website features accessible from mobile -- such as the top-nav,
site search and in-page table of contents?
- Are color contrasts significant enough for color-impaired readers?
- Are most website features usable using a keyboard only?
- Does text-to-speech offer listeners a good experience?

## Comment guidance

- Additional instructions: None.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Website requirements - Website and Infrastructure

- Display name: Website Requirements
- File stem: website-requirements

## Questions

- Are most of the applicable CNCF Website Guidelines satisfied? See
https://github.com/cncf/techdocs/blob/main/docs/website-guidelines-checklist.md

## Comment guidance

- Additional instructions: None.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Contributor Documentation

- Display name: Contributor Documentation
- Section slug: contributor-documentation

## Areas

Each row is an area in this section: its criterion label (used for the summary
ratings table) and the stem of its existing per-area comment file
(`<project-slug>-<stem>-comment.md`).

| Criterion | Comment file stem |
| ----------------------------------------- | -------------------------- |
| Communication methods documented | communication-methods-docd |
| Beginner friendly issue backlog | beginner-issue-backlog |
| "New contributor" getting started content | new-contributor |
| Project governance documentation | project-governance |
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Project Documentation

- Display name: Project Documentation
- Section slug: project-documentation

## Areas

Each row is an area in this section: its criterion label (used for the summary
ratings table) and the stem of its existing per-area comment file
(`<project-slug>-<stem>-comment.md`).

| Criterion | Comment file stem |
| -------------------------- | ------------------------ |
| Information architecture | information-architecture |
| New user content | new-user |
| Content maintainability | content-maintainability |
| Content creation processes | content-creation-process |
| Inclusive language | inclusive-language |
Loading
Loading