Skip to content

Design auditor.md integration with lecturer quality metrics #41

Description

@dcasota

Task Description

Design how to integrate photonos-docs-lecturer quality assessment into auditor droid.

Design Decisions Needed

  1. Plugin Selection:

    • Grammar checking (LanguageTool) - yes/no?
    • Markdown validation - yes/no?
    • Spelling (VMware branding) - yes/no?
    • Which other plugins?
  2. Quality Metrics:

    • Use lecturer's quality score calculation?
    • Custom metrics?
    • Thresholds for quality gates?
  3. Integration Depth:

    • Parse CSV reports?
    • Direct Python API calls?
    • Subprocess execution?
  4. Quality Gates:

    • Grammar: >95% (as proposed)?
    • Markdown: 100% (as proposed)?
    • Spelling: >98% (as proposed)?
  5. LLM Requirement:

    • Require GEMINI_API_KEY?
    • Graceful degradation without LLM?

Deliverables

  • Updated auditor.md specification
  • Quality gate definitions
  • Metric calculation methodology

Acceptance Criteria

  • ✅ Integration approach decided
  • ✅ auditor.md specification updated
  • ✅ Quality gates defined
  • ✅ Ready to implement

Related

Labels

lecturer-integration, auditor, design, medium

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions