Skip to content

docs(readme): fix discrepancies with actual implementation #18

@usernane

Description

@usernane

Description

README documents methods and features that don't exist or work differently than shown.

Examples Found

  • logSecurityViolation() shown on AbstractHandler but doesn't exist there (exists on SecurityMonitor)
  • detectSecurityIssue() shown in examples but is user-implemented, not provided
  • Some example code may not run as-is

Implementation Details

  • Audit README against actual public API
  • Remove/update incorrect examples
  • Verify all code examples are runnable
  • Add missing method documentation

Acceptance Criteria

  • All README examples work as shown
  • No references to non-existent methods
  • Code examples tested for correctness

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions