Skip to content

docs: publish an agent-readable entry point - #540

Open
Kush-Meta wants to merge 2 commits into
agntcy:mainfrom
Kush-Meta:codex/agent-readable-docs
Open

Kush-Meta wants to merge 2 commits into
agntcy:mainfrom
Kush-Meta:codex/agent-readable-docs

Conversation

@Kush-Meta

@Kush-Meta Kush-Meta commented Sep 23, 2026 •

Copy link
Copy Markdown

Coding agents fetching this documentation hub currently receive themed HTML and have no concise map of the pages or AGNTCY's separately hosted product docs. This PR makes the normal MkDocs build publish /llms.txt plus rendered Markdown for every in-repo page, so macros and includes are resolved before agents read them.

The index groups all 19 hub pages with one-line descriptions and links to the canonical Directory, SLIM, Identity, and SHADI sites. Each HTML page advertises its Markdown twin and /llms.txt in the head and has a small on-page pointer. The build fails if the index is missing, exceeds 50,000 characters, omits a page or description, contains unresolved AGNTCY macros, or links to a missing local Markdown page. The contribution guide explains how to add pages.

Validation: built the site and checked all 19 Markdown pages; checked head and on-page discovery links on all 19 HTML pages; verified the four product URLs; ran codespell, pymarkdown, Black, Python compileall, and git diff --check. A negative check confirmed that an undescribed index entry fails validation. DCO passes. Upstream Actions are currently action_required with no jobs started.

Closes #537

Signed-off-by: Kush Mehta <111352587+Kush-Meta@users.noreply.github.com>
Signed-off-by: Kush Mehta <111352587+Kush-Meta@users.noreply.github.com>
@Kush-Meta Kush-Meta changed the title docs: add agent-readable documentation entry point docs: publish an agent-readable entry point Sep 23, 2026
@Kush-Meta
Kush-Meta marked this pull request as ready for review September 23, 2026 03:01
@Kush-Meta
Kush-Meta requested a review from a team as a code owner September 23, 2026 03:01
@Kush-Meta
Kush-Meta requested review from paralta and removed request for a team September 23, 2026 03:01
@keraron
keraron requested review from keraron and removed request for paralta September 28, 2026 11:11

@keraron keraron left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, thanks for the PR. A few notes:

  • the link to llms.txt is quite awkward, there should be a more elegant way to include it, or maybe even strip it completely
  • some code fences lose their language. Fix: add pygments_lang_class: true under pymdownx.highlight
  • expected_pages uses docs.rglob("*.md"), so any non-nav Markdown under docs/ breaks the build

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs]: Make docs.agntcy.org readable for AI coding agents

2 participants