Shiprocket SOP

llms.txt follows the standard structure

llms.txt contains parseable links but doesn't fully follow the proposed structure: https://shiprocket.documentationai.com/llms.txt: No blockquote summary found

llms.txt exists

llms.txt found at 2 locations; using https://shiprocket.documentationai.com/llms.txt as canonical

llms.txt fits in an agent's context

llms.txt is 8,998 characters (under 50,000 threshold)

llms.txt links work

All 15 same-origin sampled links resolve (42 total links)

llms.txt links point to Markdown

15/15 same-origin sampled links point to markdown content (100%)

Pages point agents to llms.txt

llms.txt directive found in HTML of all 15 sampled pages, near the top of content

Markdown pages point agents to llms.txt

llms.txt directive found in markdown of all 15 sampled pages, near the top of content

Pages are available as Markdown

15/15 sampled pages support .md URLs (100%)

Server returns Markdown when asked

15/15 sampled pages support content negotiation (100%)

Markdown pages fit in context

1 of 15 pages exceed 100K chars (max 1221K)

HTML pages fit in context

1 of 15 sampled pages convert to over 100K chars (max 4680K HTML → 1225K markdown (91% boilerplate))

Content is in the HTML without JavaScript

All 15 sampled pages contain server-rendered content

Content starts near the top

Content starts within first 10% on all 15 sampled pages (median 0%)

Tabs don't bloat the page

No tabbed content detected across 15 sampled pages

Headings inside tabs name their variant

No tabbed content found; header quality check not applicable

Code blocks are well-formed

All 0 code fences properly closed across 17 pages

Missing pages return a real 404

All 15 sampled pages return proper error codes for bad URLs

Redirects stay on the same host

No redirects detected across 15 sampled pages

Markdown matches the HTML page

1 of 15 pages have minor content differences between markdown and HTML

llms.txt covers the whole site

llms.txt covers 95% of 43 sitemap doc pages; 1 llms.txt links not in sitemap (may indicate stale links or incomplete sitemap)

Cache headers allow timely updates

All 17 endpoints have appropriate cache headers

Gated docs offer another way in

All docs pages are publicly accessible; no alternative access paths needed

Docs are readable without logging in

All 15 sampled pages are publicly accessible

Crawlers and AI assistants may read the docs

robots.txt lets Googlebot, Bingbot, OAI-SearchBot, PerplexityBot, Claude-SearchBot and Claude-User read the docs.

Sitemap lists the docs pages

The sitemap at https://shiprocket.documentationai.com/sitemap.xml lists 41 of the 43 docs pages found through llms.txt and page links.

Links and section anchors work

2 of 36 references checked on the sampled pages are broken: 1 link and 1 section anchor.

Pages say when they were last changed

15 of 15 sampled pages state when they were last changed.

Sitemap entries still exist

All 10 sitemap entries sampled still exist.

Endpoints in the docs exist in the API spec

No OpenAPI description was found, so the docs could not be compared with a spec.

Deprecated operations are marked as such

No OpenAPI description was found, so deprecation notices could not be compared with a spec.