Skip to content

docs(ui): add Error List documentation#111

Merged
CalvinAllen merged 1 commit intomainfrom
docs/ui/error-list
Feb 4, 2026
Merged

docs(ui): add Error List documentation#111
CalvinAllen merged 1 commit intomainfrom
docs/ui/error-list

Conversation

@CalvinAllen
Copy link
Contributor

Summary

Add comprehensive documentation for adding errors, warnings, and messages to the Visual Studio Error List.

Topics Covered

  • ErrorListProvider usage and setup
  • ErrorTask properties reference table
  • Error categories (Error, Warning, Message)
  • Task categories (BuildCompile, CodeSense, Comments, etc.)
  • Navigation support for clicking errors to go to source location
  • Adding error codes for documentation lookup
  • Project-specific errors with hierarchy association
  • Complete ValidationService example with file-level error tracking
  • Integration with AsyncPackage
  • Best practices and common pitfalls (0-based vs 1-based line numbers)
  • IVsErrorList interface for advanced scenarios

Test plan

  • Verify the page renders correctly
  • Verify the page appears in the Fundamentals section of the sidebar
  • Verify code examples are properly syntax highlighted

Closes #44

Add comprehensive documentation for working with the Error List:
- ErrorListProvider usage
- ErrorTask properties reference
- Error categories (Error, Warning, Message)
- Task categories (BuildCompile, CodeSense, etc.)
- Navigation support for clicking to source
- Adding error codes
- Project-specific errors
- Complete validation service example
- Best practices

Closes #44
@CalvinAllen CalvinAllen merged commit f8a0433 into main Feb 4, 2026
2 checks passed
@CalvinAllen CalvinAllen deleted the docs/ui/error-list branch February 4, 2026 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

docs(ui): add Error List documentation

1 participant