Documentation fixes and restructuring#3079
Merged
Conversation
Member
harsimar
commented
Jan 21, 2026
harsimar
commented
- Fixing syntax inaccuracies
- Removing excessively repetitive/verbose parts of the documentation
- Shifted a few otel related concepts from base md to the concepts md
Contributor
There was a problem hiding this comment.
Pull request overview
This PR restructures and improves the Application Insights .NET SDK documentation by consolidating content, fixing syntax issues, and moving OpenTelemetry-related concepts to a dedicated location.
Changes:
- Moved self-diagnostics documentation from ETW/Readme.md to the main troubleshooting/Readme.md
- Added comprehensive OpenTelemetry concepts and usage patterns to docs/concepts.md
- Streamlined BASE, NETCORE, WEB, and LOGGING documentation by removing verbose sections and broken examples
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| troubleshooting/Readme.md | Added self-diagnostics section with configuration details |
| troubleshooting/ETW/Readme.md | Added warning about 2.x vs 3.x differences, removed self-diagnostics content |
| examples/BasicConsoleApp/Program.cs | Removed blank line for cleaner formatting |
| examples/AspNetCoreWebApp/AspNetCoreWebApp.csproj | Added OpenTelemetry.Exporter.Console package reference |
| docs/versions_and_names.md | Added note explaining SDK version differences in 3.x |
| docs/concepts.md | Major expansion with OpenTelemetry architecture, custom instrumentation, processors, and resource detectors |
| WEB/Src/Web/README.md | Fixed broken link from .smd to .md extension |
| WEB/Readme.md | Removed redundant architecture, migration, and troubleshooting sections |
| Readme.md | Updated with 3.x highlights and quick start guide |
| NETCORE/WorkerService.md | Removed redundant migration and troubleshooting sections |
| NETCORE/Readme.md | Removed verbose migration guide and configuration duplication |
| LOGGING/README.md | Removed deprecated logging adapter documentation |
| BASE/README.md | Streamlined by removing verbose OpenTelemetry examples and migration guides |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
rajkumar-rangaraj
approved these changes
Jan 27, 2026
rajkumar-rangaraj
approved these changes
Jan 27, 2026
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
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.