chore: fix documentation + remove unused code #1117
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
…tocapture to network capture
|
✅ No documentation updates required. |
There was a problem hiding this comment.
Pull Request Overview
This PR cleans up unused code and updates the documentation for the network-capture plugin.
- Removed unused imports and types in the plugin source
- Updated README to reflect network capture functionality instead of autocapture
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| packages/plugin-network-capture-browser/src/network-capture-plugin.ts | Removed unused ElementInteractionsOptions import and associated type alias |
| packages/plugin-network-capture-browser/README.md | Updated plugin description and usage instructions |
Comments suppressed due to low confidence (1)
packages/plugin-network-capture-browser/README.md:11
- Remove the TODO header now that the README has been updated to properly reflect the plugin functionality.
## TODO: Re-write this README.md to match plugin-network-capture
| @@ -26,9 +26,9 @@ yarn add @amplitude/plugin-network-capture-browser@beta | |||
|
|
|||
| ## Usage | |||
|
|
|||
| This plugin works on top of the Amplitude Browser SDK, generating auto-tracked events and sending to Amplitude. | |||
| This plugin works on top of the Amplitude Browser SDK, and tracks network request events | |||
There was a problem hiding this comment.
[nitpick] Remove the comma before 'and' for smoother readability: '...Browser SDK and tracks network request events.'
Copilot uses AI. Check for mistakes.
|
|
||
| To use this plugin, you need to install `@amplitude/analytics-browser` version `v1.9.1` or later. | ||
| To use this plugin, you need to install `@amplitude/plugin-network-capture-browser` |
There was a problem hiding this comment.
[nitpick] Add a period at the end of this sentence for consistency with other usage instructions.
Suggested change
| To use this plugin, you need to install `@amplitude/plugin-network-capture-browser` | |
| To use this plugin, you need to install `@amplitude/plugin-network-capture-browser`. |
Copilot uses AI. Check for mistakes.
Mercy811
approved these changes
Jun 3, 2025
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.
resulting from copy-pasting autocapture to network capture
Summary
This plugin was created by copying autocapture-browser and then renaming some stuff and re-writing. Some of the docoumentation wasn't updated properly. And there was a bit of unused code.
Checklist