✨ [RUM-10367] Browser SDK API Reference #3638
Open
+20,312
−327
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rgaignault
force-pushed
the
romanG/api-reference-github
branch
from
f4eb248 to
64eb14f
Compare
rgaignault
had a problem deploying
to
github-pages
GitHub Actions
Failure
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. 🚀 New features to boost your workflow:
|
rgaignault
had a problem deploying
to
github-pages
GitHub Actions
Failure
rgaignault
had a problem deploying
to
github-pages
GitHub Actions
Failure
rgaignault
force-pushed
the
romanG/api-reference-github
branch
from
64eb14f to
0ae4630
Compare
rgaignault
had a problem deploying
to
github-pages
GitHub Actions
Failure
rgaignault
commented
Jun 16, 2025
| on: | ||
| push: | ||
| branches: | ||
| - romanG/api-reference-github |
There was a problem hiding this comment.
Note : For testing purpose, will be deleted before pr get merged.
rgaignault
commented
Jun 16, 2025
| url: 'https://datadoghq.dev' | ||
| baseurl: '/browser-sdk' | ||
|
|
||
| remote_theme: 'just-the-docs/just-the-docs' |
There was a problem hiding this comment.
Note : we may want to delete the left bar, working on a script to delete it after generation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
See this web page to visit the api reference : https://datadoghq.dev/browser-sdk/
Test instructions
Use : docs:serve to test Jekyll locally
Checklist