Skip to content

[rum] Add RUM's plugin documentation#144

Merged
gh-worker-dd-mergequeue-cf854d[bot] merged 3 commits into
masterfrom
yoann/add-rum-documentation
May 27, 2026
Merged

[rum] Add RUM's plugin documentation#144
gh-worker-dd-mergequeue-cf854d[bot] merged 3 commits into
masterfrom
yoann/add-rum-documentation

Conversation

@yoannmoinet

@yoannmoinet yoannmoinet commented Feb 27, 2025

Copy link
Copy Markdown
Member

What and why?

Make the feature visible.

How?

Adding back its README and remove it from the list of README exceptions.

TODO

  • Find a way to bundle in types in the plugin.

Comment thread packages/plugins/rum/README.md Outdated
> the plugin makes sure the SDK is loaded before executing your code.

```ts
import type { RumTypes: { RumPublicApi } } from '@datadog/webpack-plugin';

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

This is not working because the dts() bundling doesn't bundle in @datadog/browser-rum for some reason.

Needs a fix before merging.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Changed the way we bundle the types so it now works with #370

@yoannmoinet yoannmoinet added the on-hold The PR is on hold until further notice. label May 16, 2025
@yoannmoinet yoannmoinet force-pushed the yoann/add-rum-documentation branch from 3b82838 to 87fc2b7 Compare May 14, 2026 20:57
yoannmoinet and others added 2 commits May 15, 2026 17:51
…m types

- Remove hideFromRootReadme so the plugin appears in root README automatically
- Trim sdk options in docs to only applicationId/clientToken with link to full docs
- Remove @datadog/browser-rum import from plugin source types; replace with
  explicit type definitions to avoid requiring users to install the SDK package
- Add browser-rum-types.d.ts with inlined RumInitConfiguration and DatadogRum
  types (generated via dts-bundle-generator) so users get proper TS typings
- Export DatadogRum and RumInitConfiguration from the plugin's types API
- Add TypeScript global declaration example to README using RumTypes['DatadogRum']

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@yoannmoinet yoannmoinet force-pushed the yoann/add-rum-documentation branch from 87fc2b7 to 98dd691 Compare May 15, 2026 22:08
@yoannmoinet yoannmoinet changed the base branch from master to yoann/dts-bundle-generator May 15, 2026 22:08
@yoannmoinet yoannmoinet marked this pull request as ready for review May 19, 2026 14:20
@yoannmoinet yoannmoinet requested a review from a team as a code owner May 19, 2026 14:20
Base automatically changed from yoann/dts-bundle-generator to master May 22, 2026 19:56

## Browser SDK Injection

Automatically inject the RUM SDK v6 into your application and initialize it.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Latest version is now v7

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Thanks for the heads up!
I'll fix this in a separate PR.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Opened a separate PR here: #389
If you could have a quick look @bdibon 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

mergequeue-status: done on-hold The PR is on hold until further notice.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants