GitBook

Last scanned gitbook.com/docsGitBook15 pages tested

AI agents can find, read and use these docs well. GitBook scores 91 out of 100 (grade A), passing 18 of 25 checks. 7 still need work.

Fix it with Documentation.AI

Get this report by email

We send the full report to your inbox. Nothing on this page needs an email.

Use your work email. We only send what you asked for, and every email has an unsubscribe link.

Developer docs

Kind of site

18/25

Checks passed

4

Partly passed

3

Failed

Access

Content discoverability3 passed1 failed2 partly
  • llms.txt fits in an agent's context

    llms.txt is 125,710 characters (exceeds 100,000 threshold; will be truncated by most agents)

    Your llms.txt is 125,710 characters and will be truncated by all major agent platforms. Split into a root index linking to section-level llms.txt files, each under 50,000 characters.

    Check your fix: curl -s https://gitbook.com/docs/llms.txt | wc -c prints less than 50000.

  • llms.txt follows the standard structure

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

    Your llms.txt contains parseable links but doesn't follow the standard structure. Add an H1 title as the first line and a blockquote summary (lines starting with >) to improve agent parsing.

    Check your fix: llms.txt starts with a # Title, then a > summary line, then ## sections of links.

  • Pages point agents to llms.txt

    llms.txt directive found in HTML of 15 of 15 sampled pages, but buried deep in the page (past 50%)

    An llms.txt directive was found in the HTML of some pages but is missing from others, or is buried deep in the page. Ensure the directive appears near the top of every documentation page.

    Check your fix: curl -s https://gitbook.com/docs/account-and-billing/account-settings | grep -n llms.txt finds the link near the top of the HTML.

  • llms.txt links point to Markdown

    All 717 links are external; cannot assess markdown support

  • llms.txt exists

    llms.txt found at 2 locations; using https://gitbook.com/docs/llms.txt as canonical

  • llms.txt links work

    All 15 links are external and resolve (717 total links)

  • Markdown pages point agents to llms.txt

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

Markdown availability2 passed
  • 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%)

Page size and truncation3 passed1 partly
  • Markdown pages fit in context

    1 of 15 pages between 50K–100K chars (max 70K)

    1 of 15 markdown pages are between 50K and 100K characters. These may be truncated on some agent platforms or routed through summarization. Consider splitting large pages.

  • Content is in the HTML without JavaScript

    All 15 sampled pages contain server-rendered content

  • HTML pages fit in context

    All 15 sampled pages under 50K chars (median 813K HTML → 15K markdown (98% boilerplate))

  • Content starts near the top

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

Content structure2 passed
  • Headings inside tabs name their variant

    2 page(s) with tabs found, but no section headers inside tab panels to evaluate

  • Tabs don't bloat the page

    2 tab group(s) across 2 of 15 sampled pages; all serialize under 50K chars

  • Code blocks are well-formed

    All 32 code fences properly closed across 17 pages

URL stability2 passed
  • 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

Content health1 passed2 failed
  • llms.txt covers the whole site

    llms.txt covers 712/1279 sitemap doc pages (56%); 567 missing

    Your llms.txt covers 56% of your site's pages (below 80% threshold). 567 live pages are missing from the index. If unintentional, regenerate llms.txt from your sitemap or build pipeline. If intentional, lower the threshold or set it to 0 to make the check informational.

  • Markdown matches the HTML page

    7 of 15 pages have substantive content differences between markdown and HTML (avg 39% missing)

    7 pages have substantive content differences between markdown and HTML (avg 39% missing). If unintentional, agents are getting outdated content; regenerate markdown from source or fix the build pipeline.

  • Cache headers allow timely updates

    All 17 endpoints have appropriate cache headers

Authentication and access1 passed
  • 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

Crawler access2 passed
  • 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://gitbook.com/docs/sitemap.xml lists 655 of the 721 docs pages found through llms.txt and page links.

Freshness

Maintenance2 passed1 partly
  • Links and section anchors work

    2 of 52 references checked on the sampled pages are broken: 0 links and 2 section anchors. 2 more could not be verified (timeouts or blocked requests) and are not counted.

    Fix or remove the broken links, redirect moved pages to their new address, and restore or retarget section anchors. Agents follow links to gather context, and a dead link ends that path.

    Check your fix: Every link on https://gitbook.com/docs/docs-as-code/git-sync/troubleshooting#potential-duplicated-accounts-when-signing-in (no such section) linked from https://gitbook.com/docs/account-and-billing/account-settings returns 200, and every #section link points at an element with that id.

  • 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.

Consistency with the API specNot applicable
  • Endpoints in the docs exist in the API spec

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

CurrencyNot applicable
  • Deprecated operations are marked as such

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

Additional checks

Not part of the score: optional extras that help agents use your docs.

  • MCP server is discoverable

    An MCP server is described at https://gitbook.com/docs/.well-known/mcp/server-card.json.

  • llms-full.txt is available

    llms-full.txt found at https://gitbook.com/docs/llms-full.txt (463,716 characters).

  • Agent skills are published

    7 agent skills published at https://www.gitbook.com/.well-known/agent-skills-index.json.

About this scan

Scanned
Oct 21, 2026
Pages tested
15 of 717 found
Platform
GitBook
Kind of site
Developer docs
AFDocs score, on its own
90 (A), 14 of 23 checks pass
  • Based on 15 sampled pages, chosen deterministically from the sitemap and llms.txt. Pages outside the sample were not read.
  • Pages were fetched without running JavaScript, the way most AI agents read the web.
  • robots.txt stopped the scanner from reading 1 URL; checks that needed them are unverified.
  • Answerability, where an AI agent answers real questions written from these pages, runs in the open-source scanner with your own API key. This web score is made of Access and Freshness.

Methodology 2026-09.6 · AFDocs 0.20.0

Pages we sampled (15)
  • https://gitbook.com/docs/account-and-billing/account-settings
  • https://gitbook.com/docs/create-content/blocks/code-block
  • https://gitbook.com/docs/create-content/searching-your-content/gitbook-ai
  • https://gitbook.com/docs/developers/gitbook-api/api-reference/collections/collection-permissions/invite-to-a-collection
  • https://gitbook.com/docs/developers/gitbook-api/api-reference/docs-sites/site-ai
  • https://gitbook.com/docs/developers/gitbook-api/api-reference/docs-sites/site-customization/update-the-branding-and-visual-customization-settings-for-a-site
  • https://gitbook.com/docs/developers/gitbook-api/api-reference/docs-sites/site-sections/list-all-navigation-sections-in-a-site
  • https://gitbook.com/docs/developers/gitbook-api/api-reference/integrations/list-all-site-integration-installations
  • https://gitbook.com/docs/developers/gitbook-api/api-reference/organizations/organization-ai-ask/list-recommended-questions-to-ask-in-an-organization
  • https://gitbook.com/docs/developers/gitbook-api/api-reference/spaces/space-content/compute-and-render-a-document-from-a-structured-content-source
  • https://gitbook.com/docs/developers/gitbook-api/api-reference/storage/create-a-signed-url-to-upload-a-file
  • https://gitbook.com/docs/developers/gitbook-api/rate-limiting
  • https://gitbook.com/docs/docs-as-code/git-sync/enabling-gitlab-sync
  • https://gitbook.com/docs/guides/editing-and-publishing-documentation/how-to-sync-your-entire-docs-site-with-a-git-repository
  • https://gitbook.com/docs/publish/adaptive-content/enabling-adaptive-content/cookies

Show your score

Add the badge to your docs or README. It updates each time the site is scanned.

Agent Readiness Score badge

Markdown

[![Agent Readiness Score: 91 (A)](https://documentation.ai/agent-score/badge/gitbook.svg)](https://documentation.ai/agent-score/gitbook)

HTML

<a href="https://documentation.ai/agent-score/gitbook"><img src="https://documentation.ai/agent-score/badge/gitbook.svg" alt="Agent Readiness Score: 91 (A)" height="20"></a>

Agent-ready docs by default

Documentation.AI sites ship with llms.txt, Markdown pages, a sitemap and an MCP server, and our agent keeps the content current.

Live in under 5 min · No credit card required