Repository navigation
llms.txt: API entries link bare endpoints that return 400 as linked #45452
Description
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/llms.txt (the "How to use" API section)
What part(s) of the article would you like to see updated?
hey! the three API entries in llms.txt link the bare endpoints, which return HTTP 400 as linked:
$ curl -so /dev/null -w "%{http_code}\n" https://docs.github.com/api/article/body
400
$ curl -so /dev/null -w "%{http_code}\n" "https://docs.github.com/api/article/body?pathname=/en/get-started/start-your-journey/what-is-github"
200
same for /api/article and /api/search/v1. the descriptions already contain working parameterized curl examples, so a careful reader is fine, but the llms.txt convention is that the markdown link href itself is fetchable, and plenty of agents follow the href without parsing the description. suggestion: make the link hrefs the parameterized example URLs (keeping the descriptions as they are), so naive agents get a 200 with real content instead of a 400. the other 114 links in the file all serve correctly.
Additional information
found while testing llms-txt-check, a checker that validates deployed llms.txt files (npx llms-txt-check https://docs.github.com reproduces this). for context, i maintain docusaurus-plugin-copy-page-button (runs on 28 docs sites) so i spend a lot of time in this corner of docs tooling. happy to PR the change if useful!
Activity
ggandriyangeral-a11y commentedon Aug 9, 2026
ggandriyangeral-a11y commentedon Aug 9, 2026
Sharra-writes commentedon Aug 10, 2026
@portdeveloper I'm not entirely sure this is a documentation issue, it may be one for support, but I'll check and see if we can handle it.
mezonegm-create commentedon Aug 11, 2026
Hi! I'd be happy to work on this as my first contribution to GitHub Docs, if that's okay. Thanks for reporting it!
subatoi commentedon Aug 11, 2026
Hi @portdeveloper 👋 and thank you for reporting this. I've passed the feedback to the relevant team; however, we won't be taking any action at this time so I'll go ahead and close this out for now. Many thanks for your interest in the GitHub docs!
portdeveloper commentedon Aug 13, 2026
thanks for taking a look! it is a docs-repo thing rather than support: the file is generated by
src/workflows/generate-llms-txt.tsfrom the copy indata/llms-txt/config-default.yml. i've opened #45496 with the fix, it just makes the three API entries' hrefs the parameterized example URLs that were already sitting in their descriptions, so agents that follow the link get a 200 with real content.