quarto-review-extension

Developer Documentation

Quick Links

• Setup Guide - Environment setup
• Architecture - System design
• Modules - Module documentation
• Testing - Test guide
• Contributing - Contribution guide
• API Reference - Auto-generated docs

Directory Structure

src/
├── modules/
│   ├── changes/      # Change tracking
│   ├── comments/     # CriticMarkup
│   ├── git/          # Git persistence
│   ├── markdown/     # Markdown conversion
│   ├── translation/  # Translation features
│   ├── ui/           # UI components
│   └── user/         # Authentication
└── main.ts           # Entry point

Key Concepts

Change Tracking: Operations stored as immutable history for undo/redo

CriticMarkup: {++add++}, {--del--}, {~~old~>new~~}, {>>comment<<}

Deterministic IDs: Elements identified by structure for reliable mapping

Subdirectories

• Planning - Architecture plans, roadmaps, and optimization strategies
• Analysis - Code quality, test coverage, and limitations
• Security - Security audits and vulnerability assessments

Getting Started

1. Setup - Install dependencies
2. Architecture - Understand system
3. Modules - Learn module APIs
4. Contributing - Submit code

Commands

npm run dev          # Watch mode
npm run build        # Production build
npm run test         # Run tests
npm run type-check   # TypeScript check
npm run docs         # Generate API docs

Debug Mode

review:
  debug:
    enabled: true
    level: debug
    modules: [UIModule, ChangesModule]

Console control:

window.debugLogger.enable('debug')
window.printDebugHelp()

This site is open source. Improve this page.