pyDeprecate scores 80/100 (Grade B), passing 13 of 22 checks (59%). 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 — pyDeprecate URL: https://borda.github.io/pyDeprecate/ Score: 80/100 (Grade B) I need help improving the AI-readiness of the documentation at https://borda.github.io/pyDeprecate/. Agent Score found 2 failing checks and 6 warnings. ## Failing Checks (2) - [content-discoverability] Llms Txt Links Markdown: Same-origin links point to HTML and no markdown alternatives detected (3 external links excluded) - [content-discoverability] Llms Txt Directive: No llms.txt directive found in any of 3 pages ## Warnings (6) - [markdown-availability] Markdown Url Support: 1/3 pages support .md URLs (33%); inconsistent support - [markdown-availability] Content Negotiation: Content negotiation partially supported: 1 correct type, 0 wrong type, 2 HTML only - [page-size] Page Size Markdown: 1 of 1 pages between 50K–100K chars (max 58K) - [page-size] Page Size Html: 1 of 3 pages convert to 50K–100K chars (max 58K, 48% boilerplate) - [page-size] Content Start Position: 2 of 3 pages have content starting at 10–50% (worst 22%) - [observability] Markdown Content Parity: 1 of 1 pages have minor content differences between markdown and HTML ## Fix Instructions For each issue above, please: 1. Analyze the documentation site at https://borda.github.io/pyDeprecate/ 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 https://borda.github.io/pyDeprecate/ --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-url-support1/3 pages support .md URLs (33%); inconsistent support
content-negotiationContent negotiation partially supported: 1 correct type, 0 wrong type, 2 HTML only
auth-gate-detectionAll 3 pages are publicly accessible
auth-alternative-accessAll docs pages are publicly accessible; no alternative access paths needed
page-size-markdown1 of 1 pages between 50K–100K chars (max 58K)
page-size-html1 of 3 pages convert to 50K–100K chars (max 58K, 48% boilerplate)
content-start-position2 of 3 pages have content starting at 10–50% (worst 22%)
rendering-strategyAll 3 pages contain server-rendered content
llms-txt-links-markdownSame-origin links point to HTML and no markdown alternatives detected (3 external links excluded)
llms-txt-directiveNo llms.txt directive found in any of 3 pages
llms-txt-existsllms.txt found at 1 location(s)
llms-txt-validllms.txt follows the proposed structure (H1, blockquote, heading-delimited link sections)
llms-txt-sizellms.txt is 1,897 characters (under 50,000 threshold)
llms-txt-links-resolveAll 3 same-origin links resolve (6 total links)
markdown-content-parity1 of 1 pages have minor content differences between markdown and HTML
llms-txt-freshnessllms.txt covers 100% of 3 sitemap doc pages
cache-header-hygieneAll 4 endpoints have appropriate cache headers
tabbed-content-serializationNo tabbed content detected across 3 pages
section-header-qualityNo tabbed content found; header quality check not applicable
markdown-code-fence-validityAll 49 code fences properly closed across 2 pages
http-status-codesAll 3 pages return proper error codes for bad URLs
redirect-behaviorNo redirects detected across 3 pages
