✨ [RUM-10367] Browser SDK API Reference

[rgaignault]

Motivation

This PR introduces automated API reference generation for the Browser SDK using API generator. It addresses documentation inconsistencies by centralizing the public API surface, improving maintainability, and enabling integration into Datadog Docs or GitHub Pages.

Changes

• Generate an API extractor json
• Use this json to generate markdown with API documenter
• Use Jekyll to transform the markdown into a static html website in a github pages.

See this web page to visit the api reference : https://datadoghq.dev/browser-sdk/

Test instructions

Use : docs:serve to test Jekyll locally

Checklist

• Tested locally
• Tested on staging
• Added unit tests for this change.
• Added e2e/integration tests for this change.

[codecov-commenter]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.44%. Comparing base (4233472) to head (0ae4630).
⚠️ Report is 571 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #3638   +/-   ##
=======================================
  Coverage   92.44%   92.44%           
=======================================
  Files         322      322           
  Lines        8129     8129           
  Branches     1838     1838           
=======================================
  Hits         7515     7515           
  Misses        614      614           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[rgaignault]

Note : For testing purpose, will be deleted before pr get merged.

[rgaignault]

Note : we may want to delete the left bar, working on a script to delete it after generation

[amortemousque]

💬 suggestion: ‏Instead of inlining the conf for all packages here, you should use lerna to run the command. Something like

• package.json =>
  • "docs:api:extractor": "lerna run docs:api"
  • "docs:api": "yarn docs:api:extractor && api-documenter markdown -i etc -o docs && node scripts/docs-jekyll.js"
• for all packages (e.g. rum-core/package.json):
  • "docs:api:extractor": "yarn build:esm && api-extractor run --local -c ./api-extractor.json"

[amortemousque]

The api-extractor.json configuration is almost identical across packages. To avoid duplication, we could use extends.

[thomas-lebeau]

closed in favor of #3677