Skip to content
Methodology

Developer docs discoverability

ia.developer-docs-link · 4.24

Find MAY Measured study AR-FIND-02 AR-READ-04

Why it matters

Agents and developers look for /docs, /developers or /api links on the home page to find how to integrate. An API that is only discoverable through well-known files is easy to miss.

How to fix it

Link your developer documentation from the home page with a clear link text.

  1. Add a link to /docs or /developers in the main navigation or the footer.

    <a href="/docs">Developer documentation</a>

  2. Add a service-doc Link header that points to the same documentation.

    Link: </docs>; rel="service-doc"

Verify

curl -sI https://{domain}/docs

Expected: HTTP 200 for the documentation root

Run a new scan for this checkpoint:

isagentready results {domain} --checkpoint ia.developer-docs-link
Details Mapping, lifecycle and references
AR mapping
Partial match
Score role
Bonus
Introduced
2026-08-25
Revised
2026-09-02
Methodology version
2026-10-22

Checkpoint data (JSON)