Skip to content

Conversation

rgaignault
Copy link
Contributor

@rgaignault rgaignault commented Jul 7, 2025

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

Setup typedoc and material theme with a custom css
This PR is completed by this one to enhance comment, add missing ones.

Test instructions

use yarn:docs and yarn:serve to test locally or visit the github pages

Checklist

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

@rgaignault rgaignault requested review from a team as code owners July 7, 2025 10:44
@codecov-commenter
Copy link

codecov-commenter commented Jul 7, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.33%. Comparing base (5de4d1d) to head (09747be).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3676   +/-   ##
=======================================
  Coverage   92.33%   92.33%           
=======================================
  Files         333      333           
  Lines        8313     8313           
  Branches     1871     1871           
=======================================
  Hits         7676     7676           
  Misses        637      637           

☔ 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.

Copy link

cit-pr-commenter bot commented Jul 7, 2025

Bundles Sizes Evolution

📦 Bundle Name Base Size Local Size 𝚫 𝚫% Status
Rum 149.17 KiB 149.17 KiB 0 B 0.00%
Rum Recorder 17.91 KiB 17.91 KiB 0 B 0.00%
Rum Profiler 5.15 KiB 5.15 KiB 0 B 0.00%
Logs 52.87 KiB 52.87 KiB 0 B 0.00%
Flagging 0 B 931 B 931 B N/A%
Rum Slim 107.87 KiB 107.87 KiB 0 B 0.00%
Worker 23.60 KiB 23.60 KiB 0 B 0.00%
🚀 CPU Performance
Action Name Base Average Cpu Time (ms) Local Average Cpu Time (ms) 𝚫
addglobalcontext 0.016 0.011 -0.005
addaction 0.026 0.025 -0.001
addtiming 0.005 0.007 0.002
adderror 0.031 0.028 -0.003
startstopsessionreplayrecording 0.006 0.006 0.000
startview 0.014 0.010 -0.003
logmessage 0.023 0.037 0.014
🧠 Memory Performance
Action Name Base Consumption Memory (bytes) Local Consumption Memory (bytes) 𝚫 (bytes)
addglobalcontext 28.31 KiB 27.49 KiB -843 B
addaction 56.06 KiB 56.24 KiB 180 B
addtiming 27.37 KiB 26.84 KiB -544 B
adderror 58.99 KiB 60.82 KiB 1.83 KiB
startstopsessionreplayrecording 25.33 KiB 24.96 KiB -378 B
startview 430.49 KiB 428.21 KiB -2337 B
logmessage 60.25 KiB 100.82 KiB 40.57 KiB

🔗 RealWorld

@rgaignault rgaignault force-pushed the romanG/typedoc-api-ref branch from 1f8a5c8 to 1490d37 Compare July 7, 2025 11:13
@rgaignault rgaignault force-pushed the romanG/typedoc-api-ref branch from 1490d37 to d18401e Compare July 7, 2025 11:14
@rgaignault rgaignault force-pushed the romanG/typedoc-api-ref branch from d18401e to 778ecf4 Compare July 8, 2025 10:17
@rgaignault rgaignault changed the title api-ref 📝 Typedoc setup and theme Jul 8, 2025
@rgaignault rgaignault force-pushed the romanG/typedoc-api-ref branch from 51406a6 to 8ce167e Compare July 23, 2025 13:06
@rgaignault rgaignault merged commit 82bfa19 into main Jul 25, 2025
20 checks passed
@rgaignault rgaignault deleted the romanG/typedoc-api-ref branch July 25, 2025 01:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants