speakeasy-api / speakeasy-api/developer-docs

llms.txt points at .md mirrors that 404 (the HTML pages are fine)

Open
#106 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
MDX
Stars
10
Forks
16
PR merge metrics
No merged PRs in 30d

Description

Hi — the .md mirrors that https://docs.speakeasy.com/llms.txt points at are 404ing for a good chunk of the index, while the corresponding HTML pages are all fine.

I was sampling published llms.txt files across ~25 doc sites for an unrelated reason. Speakeasy came out as an outlier, so I went and checked it properly instead of trusting the first number.

Random sample, 15 of the 20 indexed URLs, seeded so it's reproducible — 7 return 404:

404  /md/docs/standalone-mcp/overview.md
404  /md/docs/standalone-mcp/build-server.md
404  /md/docs/standalone-mcp/setting-up-oauth.md
404  /md/docs/standalone-mcp/custom-resources.md
404  /md/docs/standalone-mcp/remote-mcp-servers.md
404  /md/docs/standalone-mcp/cloudflare-deployment.md
404  /md/docs/speakeasy-reference/generation/terraform-config.md

The part I think actually matters: the content isn't missing, only the machine copy is. Strip /md/ and the .md and every one of them is a 200:

/md/docs/standalone-mcp/overview.md                          404
/docs/standalone-mcp/overview                                200

/md/docs/standalone-mcp/build-server.md                      404
/docs/standalone-mcp/build-server                            200

/md/docs/speakeasy-reference/generation/terraform-config.md  404
/docs/speakeasy-reference/generation/terraform-config        200

So the site is healthy and the mirror that llms.txt exists to serve is not. Which means the audience that hits this is the only one that can't tell you about it — a person browsing never touches /md/, and an agent following your index just gets a 404 and moves on. I'd guess that's why it's been sitting there.

Checked before filing, because either would have made this mine rather than yours:

  • Not my user agent. Every non-200 refetched with a normal Chrome UA — zero recovered.
  • Not an unfollowed redirect. redirect: 'follow' throughout, and the HTML equivalents resolve 200 under the identical client.

Repro:

curl -s https://docs.speakeasy.com/llms.txt \
  | grep -oE 'https://[^)]+' \
  | while read u; do printf '%s %s\n' "$(curl -s -o /dev/null -w '%{http_code}' -L "$u")" "$u"; done \
  | grep -v '^200'

No ask attached — it just seemed like the kind of thing that stays broken precisely because nobody who can see it is looking.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at https://docs.speakeasy.com/llms.txt and reproduce the listed failures with the provided curl command. Inspect how the /md/ URLs are generated or routed, then verify that the affected links return 200 while their corresponding HTML pages remain available.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.