WorkOS

workos.com/docs
Score: 79 out of 100, grade C79
Grade C
Last checked: May 12, 2026 · afdocs v0.17.1 · Rerun
Share on
Simulation: Fern // bud
Day 0
CategoryBusiness
Checks passed13/23Warnings4Failed4

WorkOS scores 79/100 (Grade C), passing 13 of 23 checks (57%). The documentation is broadly accessible to AI agents but has 8 areas that could be improved to better serve automated tooling.

# Agent Score Fix Report — WorkOS
URL: https://workos.com/docs
Score: 79/100 (Grade C)

I need help improving the AI-readiness of the documentation at https://workos.com/docs.
Agent Score found 4 failing checks and 4 warnings.

## Failing Checks (4)
- [content-discoverability] Llms Txt Directive Html: No llms.txt directive found in HTML of any of 10 sampled pages
- [content-discoverability] Llms Txt Directive Md: No llms.txt directive found in markdown of any of 10 sampled pages
- [observability] Markdown Content Parity: 1 of 10 pages have substantive content differences between markdown and HTML (avg 14% missing)
- [observability] Cache Header Hygiene: 10 of 12 endpoints have aggressive caching or missing cache headers

## Warnings (4)
- [content-discoverability] Llms Txt Size: llms.txt is 63,886 characters (between 50,000 and 100,000; consider splitting)
- [content-discoverability] Llms Txt Links Markdown: Same-origin links point to HTML, but 10 have .md variants available
- [page-size] Content Start Position: 8 of 10 sampled pages have content starting at 10–50% (worst 50%)
- [observability] Llms Txt Coverage: llms.txt covers 319/350 sitemap doc pages (91%); 31 missing; 246 llms.txt links not in sitemap (may indicate stale links or incomplete sitemap)

## Fix Instructions

For each issue above, please:
1. Analyze the documentation site at https://workos.com/docs
2. Implement the specific fix
3. Verify the fix would cause the check to pass

### Common fixes:
- **No llms.txt**: Create /llms.txt following https://llmstxt.org — list all doc pages in markdown format
- **No .md URL support**: Configure your docs platform to serve pages at equivalent .md URLs (e.g. /docs/quickstart.md)
- **No content negotiation**: Return markdown when request includes Accept: text/markdown header
- **Large page size**: Reduce nav boilerplate, inline scripts, and repetitive markup
- **No sitemap**: Generate /sitemap.xml listing all documentation URLs
- **Auth walls**: Ensure docs pages return 200 without requiring login cookies or tokens
- **No Last-Modified header**: Configure your server/CDN to include Last-Modified response headers
- **Tab content hidden**: Ensure tabbed content is rendered in the HTML (not JS-only) so agents can read all variants

## Run afdocs Locally for More Detail

To get deeper visibility into what's failing, run afdocs against your docs:

  npx afdocs check https://workos.com/docs --fixes --verbose

- **--fixes**: Adds "Fix:" lines to the output for each warn/fail check with actionable remediation steps
- **-v, --verbose**: Shows per-page details (specific URLs, character counts, error codes) for checks with issues — useful for per-URL visibility into what's failing
CHECK RESULTS

How your docs scored

markdown-content-parity1 of 10 pages have substantive content differences between markdown and HTML (avg 14% missing)Learn more
cache-header-hygiene10 of 12 endpoints have aggressive caching or missing cache headersLearn more
llms-txt-coveragellms.txt covers 319/350 sitemap doc pages (91%); 31 missing; 246 llms.txt links not in sitemap (may indicate stale links or incomplete sitemap)Learn more
auth-gate-detectionAll 10 sampled pages are publicly accessibleLearn more
auth-alternative-accessAll docs pages are publicly accessible; no alternative access paths neededLearn more
llms-txt-directive-htmlNo llms.txt directive found in HTML of any of 10 sampled pagesLearn more
llms-txt-directive-mdNo llms.txt directive found in markdown of any of 10 sampled pagesLearn more
llms-txt-sizellms.txt is 63,886 characters (between 50,000 and 100,000; consider splitting)Learn more
llms-txt-links-markdownSame-origin links point to HTML, but 10 have .md variants availableLearn more
llms-txt-existsllms.txt found at 2 locations; using https://workos.com/docs/llms.txt as canonicalLearn more
llms-txt-validllms.txt follows the proposed structure (H1, blockquote, heading-delimited link sections)Learn more
llms-txt-links-resolveAll 10 same-origin sampled links resolve (566 total links)Learn more
tabbed-content-serialization38 tab group(s) across 8 of 10 sampled pages; all serialize under 50K charsLearn more
markdown-code-fence-validityAll 216 code fences properly closed across 12 pagesLearn more
section-header-quality8 page(s) with tabs found, but no section headers inside tab panels to evaluateLearn more
content-start-position8 of 10 sampled pages have content starting at 10–50% (worst 50%)Learn more
rendering-strategyAll 10 sampled pages contain server-rendered contentLearn more
page-size-markdownAll 10 pages under 50K chars (median 12K, max 24K)Learn more
page-size-htmlAll 10 sampled pages under 50K chars (median 3857K HTML → 35K markdown (97% boilerplate))Learn more
markdown-url-support10/10 sampled pages support .md URLs (100%)Learn more
content-negotiation10/10 sampled pages support content negotiation (100%)Learn more
http-status-codesAll 10 sampled pages return proper error codes for bad URLsLearn more
redirect-behaviorAll 8 redirect(s) across 10 sampled pages are same-host HTTP redirectsLearn more

Built by Fern

Fern-powered docs are agent-ready by default.

Trusted by