Electron
Last scanned electronjs.org/docs/latestDocusaurus15 pages tested
AI agents have real trouble using these docs. Start with the top fixes. Electron scores 59 out of 100 (grade F), passing 15 of 21 checks. 6 still need work.
The score is held at 59 because no llms.txt was found, and a site without one cannot score higher.
Developer docs
Kind of site
15/21
Checks passed
1
Partly passed
5
Failed
Access
Content discoverability3 failed
llms.txt exists
No llms.txt found at any candidate location (https://www.electronjs.org/docs/latest/llms.txt, https://www.electronjs.org/llms.txt, https://www.electronjs.org/docs/llms.txt)
Create an llms.txt file at your site root containing an H1 title, a blockquote summary, and markdown links to your key documentation pages. This is the single highest-impact improvement for agent access to your docs.
Check your fix:
curl -sI https://www.electronjs.org/docs/latest/llms.txtreturns 200 with a text content type.Pages point agents to llms.txt
No llms.txt directive found in HTML of any of 15 sampled pages
No agent-facing directive pointing to llms.txt was detected in the HTML of any tested page. Add a visually-hidden element near the top of each page (e.g., a div with CSS clip-rect) containing a link to your llms.txt. If your site serves markdown versions of pages, mention that in the directive too so agents know to request it.
Check your fix:
curl -s https://electronjs.org/docs/latest/ | grep -n llms.txtfinds the link near the top of the HTML.Markdown pages point agents to llms.txt
No llms.txt directive found in markdown of any of 14 sampled pages; 1 had no markdown version
No llms.txt directive was detected in the markdown of any tested page. Add a blockquote near the top of each markdown page (e.g., "> For the complete documentation index, see [llms.txt](/llms.txt)").
Check your fix: The Markdown version of https://electronjs.org/docs/latest/ (its .md URL, or the page fetched with
Accept: text/markdown) has the llms.txt line in its first few lines.llms.txt follows the standard structure
Skipped: dependency check did not pass
llms.txt fits in an agent's context
Skipped: dependency check did not pass
llms.txt links work
Skipped: dependency check did not pass
llms.txt links point to Markdown
Skipped: dependency check did not pass
Markdown availability1 passed1 failed
Server returns Markdown when asked
Server ignores Accept: text/markdown header (0/15 sampled pages return markdown)
Your server ignores Accept: text/markdown and returns HTML. Some agents (Claude Code, Cursor, OpenCode) request markdown this way. Configure your server to honor content negotiation.
Check your fix:
curl -sI -H "Accept: text/markdown" https://electronjs.org/docs/latest/returnscontent-type: text/markdown.Pages are available as Markdown
14/15 sampled pages support .md URLs (93%)
Page size and truncation3 passed1 failed
Content starts near the top
5 of 15 sampled pages have content starting past 50% (worst 78%)
5 of 15 pages have content starting past 50% of the converted output. Agents may never see the documentation content. Reduce navigation, breadcrumb, and sidebar markup that precedes the content area.
Content is in the HTML without JavaScript
All 15 sampled pages contain server-rendered content
Markdown pages fit in context
All 14 pages under 50K chars (median 4K, max 16K)
HTML pages fit in context
All 15 sampled pages under 50K chars (median 48K HTML → 14K markdown (74% boilerplate))
Content structure2 passed
Headings inside tabs name their variant
1 page(s) with tabs found, but no section headers inside tab panels to evaluate
Tabs don't bloat the page
1 tab group(s) across 1 of 15 sampled pages; all serialize under 50K chars
Code blocks are well-formed
All 41 code fences properly closed across 14 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
All 15 redirect(s) across 15 sampled pages are same-host HTTP redirects
Content health1 passed1 partly
Markdown matches the HTML page
3 of 14 pages have minor content differences between markdown and HTML
3 pages have minor content differences between their markdown and HTML versions.
llms.txt covers the whole site
Skipped: dependency check did not pass
Cache headers allow timely updates
All 15 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://www.electronjs.org/sitemap.xml lists 90 of the 90 docs pages found through llms.txt and page links.
Freshness
Maintenance3 passed
Pages say when they were last changed
15 of 15 sampled pages state when they were last changed.
Links and section anchors work
All 14 links checked on the sampled pages work. 2 more could not be verified (timeouts or blocked requests) and are not counted.
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
No MCP server was found for these docs.
Offer a read-only MCP server with a search tool over your docs, and link it from llms.txt, so agents in Cursor, Claude and ChatGPT can query your docs directly.
llms-full.txt is available
No llms-full.txt found at https://www.electronjs.org/docs/latest/llms-full.txt or https://www.electronjs.org/llms-full.txt.
Publish /llms-full.txt with the full text of your docs in Markdown, so an agent can load everything in one request instead of crawling page by page.
Check your fix:
curl -sI https://www.electronjs.org/docs/latest/llms-full.txtreturns 200.Agent skills are published
No agent skills index was found at /.well-known/agent-skills/index.json.
Publish an Agent Skills index at /.well-known/agent-skills/index.json with a SKILL.md for your main tasks, so agents can load task instructions without reading every page.
About this scan
- Scanned
- Oct 21, 2026
- Pages tested
- 15 of 290 found
- Platform
- Docusaurus
- Kind of site
- Developer docs
- AFDocs score, on its own
- 59 (F), 10 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 2 URLs; 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://electronjs.org/docs/latest/
- https://electronjs.org/docs/latest/api/debugger
- https://electronjs.org/docs/latest/api/native-image
- https://electronjs.org/docs/latest/api/structures/activation-arguments
- https://electronjs.org/docs/latest/api/structures/filesystem-permission-request
- https://electronjs.org/docs/latest/api/structures/mouse-wheel-input-event
- https://electronjs.org/docs/latest/api/structures/protocol-request
- https://electronjs.org/docs/latest/api/structures/shared-texture-imported
- https://electronjs.org/docs/latest/api/structures/web-preferences
- https://electronjs.org/docs/latest/api/tray
- https://electronjs.org/docs/latest/development/chromium-development
- https://electronjs.org/docs/latest/faq
- https://electronjs.org/docs/latest/tutorial/devtools-extension
- https://electronjs.org/docs/latest/tutorial/native-code-and-electron
- https://electronjs.org/docs/latest/tutorial/spellchecker
Show your score
Add the badge to your docs or README. It updates each time the site is scanned.
Markdown
[](https://documentation.ai/agent-score/electronjs)HTML
<a href="https://documentation.ai/agent-score/electronjs"><img src="https://documentation.ai/agent-score/badge/electronjs.svg" alt="Agent Readiness Score: 59 (F)" height="20"></a>Agent-ready docs by default
Live in under 5 min · No credit card required