Skip to content

Design editor.md integration with lecturer automated fixes #42

Description

@dcasota

Task Description

Design how to integrate photonos-docs-lecturer automated fixes into editor droid.

Design Decisions Needed

  1. Fix Categories to Enable:

    • Deterministic (FIX_ID 2,3,7,8) - always?
    • LLM-assisted (FIX_ID 9,10,11) - optional?
    • Special (FIX_ID 13,14) - default disabled?
  2. LLM Configuration:

    • Require GEMINI_API_KEY?
    • Fallback without LLM?
    • Alternative: XAI_API_KEY?
  3. Selective Fixing:

    • By category (critical, branding, formatting)?
    • By FIX_ID?
    • All at once?
  4. Validation Strategy:

    • Automatic rollback on failure?
    • Run installer.sh after fixes?
    • Quality metric comparison?
  5. Integration Method:

    • Use lecturer's run command?
    • Disable PR creation (editor handles)?
    • Custom fix application?

Deliverables

  • Updated editor.md specification
  • Fix workflow design
  • Rollback strategy

Acceptance Criteria

  • ✅ Fix strategy decided
  • ✅ editor.md specification updated
  • ✅ Validation approach defined
  • ✅ Ready to implement

Related

Labels

lecturer-integration, editor, 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