Skip to content

[Chore]: Update documentation for System.CommandLine 2.0.0-beta5 changes #20

@ahmedig

Description

@ahmedig

Area

Documentation

Motivation

After completing the System.CommandLine 2.0.0-beta5 upgrade, documentation needs to be updated to reflect any changes in:

  • Internal API references that may affect developers
  • Code comments that reference old API patterns
  • Developer setup instructions if any dependencies changed
  • Architecture documentation that mentions command-line parsing

Task Description

Review and update internal documentation and code comments to ensure accuracy with the new System.CommandLine 2.0.0-beta5 implementation.

Documentation Areas to Review:

1. Code Comments:

  • Review all command handler files for outdated API references
  • Update comments in Program.cs and base classes
  • Ensure example code in comments reflects new patterns
  • Update any TODO comments related to command-line parsing

2. Developer Documentation:

  • Review docs/QUICKSTART.md for any CLI-related instructions
  • Update docs/INSTALLATION.md if any setup steps changed
  • Check README.md for outdated CLI examples
  • Verify any architecture documentation is accurate

3. Internal Comments:

  • Update method documentation in command handlers
  • Review XML documentation comments for accuracy
  • Update any inline comments referencing old API patterns
  • Ensure error message documentation is current

4. Configuration Files:

  • Review any .editorconfig or analysis rule files
  • Check if any project settings need updates
  • Verify that code analysis rules are still appropriate

Files to Review:

  • All files in src/GenAIDBExplorer/GenAIDBExplorer.Console/CommandHandlers/
  • src/GenAIDBExplorer/GenAIDBExplorer.Console/Program.cs
  • docs/QUICKSTART.md
  • docs/INSTALLATION.md
  • README.md
  • Any other developer-facing documentation

Acceptance Criteria

  • All code comments accurately reflect new API patterns
  • Developer documentation contains no outdated CLI instructions
  • Method documentation is updated for new parameter patterns
  • README.md examples (if any) are current
  • No references to old System.CommandLine API patterns remain
  • Error message documentation is accurate
  • Any CLI examples in documentation work correctly

Impact / Risk

Related Issues:

Metadata

Metadata

Assignees

Labels

choredocumentationImprovements or additions to documentation

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions