Education
18% of overallCan a new developer get to 'hello world' without asking anyone?
What it measures
We crawl the docs site (and a sample of READMEs) and grade it on discoverability and structure: is there a quickstart, an API reference, tutorials, in-page search, copy-pasteable code samples, and a visible version selector? The repo-level AI-readiness signal rates how well READMEs work as context for LLM assistants.
Why it matters
Docs are where the funnel collapses or compounds. A good docs site deflects support load, lets AI assistants answer accurately about your product, and converts evaluators into integrators on a Sunday afternoon.
Sub-metrics
| Metric | What we read | Weight | Source |
|---|---|---|---|
| Docs grade | Quickstart, API reference, tutorials, search, code samples, version selector | 50% (when a docs URL is provided) | Firecrawl + LLM grader |
| README review | Getting-started clarity, install instructions, code samples, structure of top repos | 50% (when READMEs are available) | GitHub READMEs + LLM grader |
How it's weighted
Docs grade and README review are weighted equally. If only one signal is available, it carries the full pillar; if neither is present, the score falls back to the repo polish average.
Best practices
- Host docs on a dedicated subdomain (docs.yourdomain.com) — easier to crawl, easier to share.
- Make the quickstart the landing page of /docs. Install, configure, first call — three steps, all copyable.
- Provide a visible table of contents and in-page search. AI crawlers and humans both rely on it.
- Ship runnable examples per language/SDK, not just code fences.
- Add a version selector so users land on docs that match their installed SDK.
- Publish an OpenAPI spec or SDK reference page that mirrors the actual API.