Skip to content

Generate llms.txt using Docsy v0.14.3-44-gc6834296#9614

Merged
chalin merged 3 commits intoopen-telemetry:mainfrom
chalin:chalin-m24-docsy-update-2026-0408-1847
Apr 9, 2026
Merged

Generate llms.txt using Docsy v0.14.3-44-gc6834296#9614
chalin merged 3 commits intoopen-telemetry:mainfrom
chalin:chalin-m24-docsy-update-2026-0408-1847

Conversation

@chalin
Copy link
Copy Markdown
Contributor

@chalin chalin commented Apr 8, 2026

  • Contributes to Provide agent-friendly content & support #9449
  • Upgrades Docsy to v0.14.3-44-gc6834296, which:
    • Adds support for llms.txt
    • Updates various i18n files, adding ro in particular
  • Uses docsy to add support for /llms.txt generation

Preview

Generated llms.txt

llms.txt...
# OpenTelemetry

> The open standard for telemetry

## Site index

- [Home page](https://deploy-preview-9614--opentelemetry.netlify.app/index.md)
- [Docs](https://deploy-preview-9614--opentelemetry.netlify.app/docs/index.md)
- [Ecosystem](https://deploy-preview-9614--opentelemetry.netlify.app/ecosystem/index.md): OpenTelemetry's thriving ecosystem of components, examples, integrations and vendors
- [Status](https://deploy-preview-9614--opentelemetry.netlify.app/status/index.md): Maturity-level of the main OpenTelemetry components
- [Community](https://deploy-preview-9614--opentelemetry.netlify.app/community/index.md)
- [Training](https://deploy-preview-9614--opentelemetry.netlify.app/training/index.md): OpenTelemetry certifications and courses
- [Blog](https://deploy-preview-9614--opentelemetry.netlify.app/blog/index.md): OpenTelemetry blog

## Documentation index

- [Getting Started](https://deploy-preview-9614--opentelemetry.netlify.app/docs/getting-started/index.md)
- [OpenTelemetry Concepts](https://deploy-preview-9614--opentelemetry.netlify.app/docs/concepts/index.md)
- [OpenTelemetry Demo Docs](https://deploy-preview-9614--opentelemetry.netlify.app/docs/demo/index.md)
- [Language APIs & SDKs](https://deploy-preview-9614--opentelemetry.netlify.app/docs/languages/index.md)
- [Platforms and environments](https://deploy-preview-9614--opentelemetry.netlify.app/docs/platforms/index.md)
- [Zero-code Instrumentation](https://deploy-preview-9614--opentelemetry.netlify.app/docs/zero-code/index.md)
- [Collector](https://deploy-preview-9614--opentelemetry.netlify.app/docs/collector/index.md)
- [Blueprints and reference implementations](https://deploy-preview-9614--opentelemetry.netlify.app/docs/guidance/index.md)
- [Compatibility](https://deploy-preview-9614--opentelemetry.netlify.app/docs/compatibility/index.md)
- [Specifications](https://deploy-preview-9614--opentelemetry.netlify.app/docs/specs/index.md)
- [Security](https://deploy-preview-9614--opentelemetry.netlify.app/docs/security/index.md)
- [Contributing](https://deploy-preview-9614--opentelemetry.netlify.app/docs/contributing/index.md)

## Site locales

- [বাংলা](https://deploy-preview-9614--opentelemetry.netlify.app/bn/index.md)
- [English](https://deploy-preview-9614--opentelemetry.netlify.app/index.md)
- [Español](https://deploy-preview-9614--opentelemetry.netlify.app/es/index.md)
- [Français](https://deploy-preview-9614--opentelemetry.netlify.app/fr/index.md)
- [日本語](https://deploy-preview-9614--opentelemetry.netlify.app/ja/index.md)
- [Polski](https://deploy-preview-9614--opentelemetry.netlify.app/pl/index.md)
- [Português](https://deploy-preview-9614--opentelemetry.netlify.app/pt/index.md)
- [Română](https://deploy-preview-9614--opentelemetry.netlify.app/ro/index.md)
- [Українська](https://deploy-preview-9614--opentelemetry.netlify.app/uk/index.md)
- [中文](https://deploy-preview-9614--opentelemetry.netlify.app/zh/index.md)

AFD score of 100% (across measured metrics)

Details
Agent-Friendly Docs Scorecard
==============================

https://deploy-preview-9614--opentelemetry.netlify.app · 4/8/2026, 7:09:17 PM

  Overall Score: 100 / 100 (A+)

  Category Scores:
    Content Discoverability              100 / 100 (A+)
    Markdown Availability                100 / 100 (A+)
    Page Size and Truncation Risk        100 / 100 (A+)
    Content Structure                    100 / 100 (A+)
    URL Stability and Redirects          100 / 100 (A+)
    Observability and Content Health     100 / 100 (A+)
    Authentication and Access            100 / 100 (A+)

  Check Results:

    Content Discoverability
      PASS  llms-txt-exists                llms.txt found at 1 location(s)
      PASS  llms-txt-valid                 llms.txt follows the proposed structure (H1, blockquote, heading-delimited link sections)
      PASS  llms-txt-size                  llms.txt is 2,934 characters (under 50,000 threshold)
      PASS  llms-txt-links-resolve         All 28 same-origin links resolve (28 total links)
      PASS  llms-txt-links-markdown        28/28 same-origin links point to markdown content (100%)
      PASS  llms-txt-directive             llms.txt directive found in all 28 pages, near the top of content

    Markdown Availability
      PASS  markdown-url-support           28/28 pages support .md URLs (100%)
      PASS  content-negotiation            28/28 pages support content negotiation (100%)

    Page Size and Truncation Risk
      PASS  rendering-strategy             All 28 pages contain server-rendered content
      PASS  page-size-markdown             All 28 pages under 50K chars (median 4K, max 16K)
      PASS  page-size-html                 All 28 pages convert under 50K chars (median 4K, 0% boilerplate)

    Content Structure
      PASS  tabbed-content-serialization   No tabbed content detected across 28 pages
      PASS  section-header-quality         No tabbed content found; header quality check not applicable
      PASS  markdown-code-fence-validity   All 0 code fences properly closed across 29 pages

    URL Stability and Redirects
      PASS  http-status-codes              All 28 pages return proper error codes for bad URLs
      PASS  redirect-behavior              No redirects detected across 28 pages

    Observability and Content Health
      PASS  cache-header-hygiene           All 29 endpoints have appropriate cache headers

    Authentication and Access
      PASS  auth-gate-detection            All 28 pages are publicly accessible
      SKIP  auth-alternative-access        All docs pages are publicly accessible; no alternative access paths needed

No unexpected changes to the other files

Diff...
$ find public/ -type f -name '*.md' -exec perl -i -0777 -pe '                           
  s/\nLLMS index:\s*\[[^\]]+\]\([^)]+\)\n\n---\n\n/\n/g;
  s/\nLLMS index:\s*\[[^\]]+\]\([^)]+\)\n---\n\n/\n/g;
  s/^LLMS index:\s*\[[^\]]+\]\([^)]+\)\n\n---\n\n/\n/m;
' {} +
$ (cd public && git diff -bw --ignore-blank-lines -I 'td-page-meta__markdown') | grep ^diff | grep -v '\.xml$' | grep -v ' a/ro/'
diff --git a/site/index.html b/site/index.html
diff --git a/site/index.md b/site/index.md

image

For the full report, see https://buildwithfern.com/agent-score/company/opentelemetry.

@chalin chalin requested a review from a team as a code owner April 8, 2026 23:03
@github-actions github-actions bot added dependencies Pull requests that update a dependency file CI/infra Repo CI & infrastructure labels Apr 8, 2026
@otelbot-docs otelbot-docs bot added the missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer label Apr 8, 2026
@chalin
Copy link
Copy Markdown
Contributor Author

chalin commented Apr 8, 2026

I'm not sure why the linter and spell-check are failing. It seems unrelated to the llms.txt feature.

Copy link
Copy Markdown
Member

@theletterf theletterf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

@otelbot-docs otelbot-docs bot added ready-to-be-merged This PR is ready to be merged by a maintainer and removed missing:docs-approval Co-owning SIG has provided approval, PR needs approval from docs maintainer labels Apr 9, 2026
@chalin chalin added this pull request to the merge queue Apr 9, 2026
Merged via the queue into open-telemetry:main with commit 1ec80b5 Apr 9, 2026
25 checks passed
@chalin chalin deleted the chalin-m24-docsy-update-2026-0408-1847 branch April 9, 2026 12:18
tiffany76 pushed a commit to tiffany76/opentelemetry.io that referenced this pull request Apr 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/infra Repo CI & infrastructure dependencies Pull requests that update a dependency file ready-to-be-merged This PR is ready to be merged by a maintainer

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants