Skip to content

docs: resolve open documentation issues - #191

Open
Hector Hernandez (hectorhdzg) wants to merge 3 commits into
microsoft:mainfrom
hectorhdzg:hectorhdzg-fix-documentation-issues
Open

docs: resolve open documentation issues#191
Hector Hernandez (hectorhdzg) wants to merge 3 commits into
microsoft:mainfrom
hectorhdzg:hectorhdzg-fix-documentation-issues

Conversation

@hectorhdzg

@hectorhdzg Hector Hernandez (hectorhdzg) commented Sep 8, 2026

Copy link
Copy Markdown
Member

Updates the React plugin documentation to resolve all currently open documentation-labeled issues:

  • Replaces the outdated external sample application link with the maintained sample in this repository.
  • Explains when to use enableAutoRouteTracking, autoTrackPageVisitTime, and withAITracking, including the telemetry each option produces.
  • Documents common use cases for explicit tracking methods and how to avoid duplicate telemetry.
  • Clarifies that the React plugin and Application Insights web SDK should use compatible versions and be updated together.
  • Adds the current 19.4.1 release to the compatibility matrix.
  • Keeps the root and npm package READMEs consistent.

Fixes #12
Fixes #48
Fixes #63

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI lite review requested due to automatic review settings September 8, 2026 21:12

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

The compatibility matrix adds a 19.4.1 entry that does not appear to be a published release, which can mislead users about available/compatible versions.

Once you've addressed the issues Copilot identified, you can request another Copilot review.

Pull request overview

This PR updates the React plugin documentation to address open documentation issues by modernizing links, clarifying tracking/telemetry options, and guiding users on version compatibility between the React plugin and the Application Insights web SDK.

Changes:

  • Documented when to use enableAutoRouteTracking, autoTrackPageVisitTime, and withAITracking, including the telemetry each produces.
  • Added guidance on explicit tracking methods and avoiding duplicate telemetry.
  • Updated the sample app link and added/updated compatibility/version guidance.
File summaries
File Description
README.md Adds tracking-approach guidance, updates sample app link, and updates the compatibility matrix.
applicationinsights-react-js/README.md Mirrors the tracking-approach guidance and updates the sample app link for the npm/package README.
Review details
  • Files reviewed: 2/2 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
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.

[BUG] Sample App - link update [Documentation] Include common react usecases. [BUG] Typing issue with @microsoft/applicationinsights-web v2.7.0

2 participants