Update docs

Author: kush-duolingo

README.md

@@ -42,7 +42,12 @@ All `docker_image` entries found in `.pre-commit-config.yaml` will be included,
 
 ## Sync AI Rules Hook (`sync-ai-rules`)
 
-This hook synchronizes AI coding rules from .cursor/rules/\*.mdc files to other AI assistant configuration files (CLAUDE.md, AGENTS.md, etc.). This ensures all AI coding assistants in your project stay aware of the same rules and conventions, eliminating the need to manually copy rules between different AI config files.
+This hook synchronizes AI coding rules from `.cursor/rules/` and `.code_review/` directories to AI assistant configuration files (CLAUDE.md, AGENTS.md, .github/copilot-instructions.md). It generates two sections:
+
+- **Development Rules** - from `.cursor/rules/*.mdc` files with YAML frontmatter
+- **Review Guidelines** - from `.code_review/*.md` files with HTML comment frontmatter
+
+This ensures all AI coding assistants stay aware of the same rules and conventions.
 
 ## Usage
 

sync_ai_rules/README.md

@@ -1,52 +1,64 @@
 # sync-ai-rules
 
-- Synchronize AI coding rules from .cursor/rules/\*.mdc files to other AI assistant configuration files (CLAUDE.md, AGENTS.md, etc.)
-- Built with a plugin architecture that can easily support new input/output formats as the ecosystem evolves
+Synchronizes AI coding rules to configuration files for Claude, GitHub Copilot, and other AI assistants. Parses rules from source directories and generates documentation sections automatically.
 
-## Extending to new formats
+## Supported Formats
 
-### Adding New Input Parsers
+- **Development Rules** - `.cursor/rules/*.mdc` files (YAML frontmatter) → Development Rules section
+- **Review Guidelines** - `.code_review/*.md` files (HTML comment frontmatter) → Review Guidelines section
 
-Create a parser class implementing `InputParser` in `sync_ai_rules/parsers/`:
+Target files: `CLAUDE.md`, `AGENTS.md`, `.github/copilot-instructions.md`
+
+## Extending the System
+
+### Create a New Pipeline
+
+1. **Create a parser** in `sync_ai_rules/parsers/`:
 
 ```python
-from sync_ai_rules.core.interfaces import InputParser, RuleMetadata
+from sync_ai_rules.core.parser_interface import InputParser
+from sync_ai_rules.core.rule_metadata import RuleMetadata
 
 class YourParser(InputParser):
     @property
     def name(self) -> str:
         return "your-format"
 
-    # Implement required methods...
-```
+    @property
+    def source_directories(self) -> list[str]:
+        return [".your-rules"]  # Where to scan
 
-### Adding New Output Generators
+    # Implement can_parse() and parse()...
+```
 
-Create a generator class implementing `OutputGenerator` in `sync_ai_rules/generators/`:
+2. **Create a generator** in `sync_ai_rules/generators/`:
 
 ```python
-from sync_ai_rules.core.interfaces import OutputGenerator
+from sync_ai_rules.generators.base_generator import BaseGenerator
 
-class YourGenerator(OutputGenerator):
+class YourGenerator(BaseGenerator):
     @property
     def name(self) -> str:
         return "your-output"
 
-    # Implement required methods...
-```
+    def get_section_markers(self) -> tuple[str, str]:
+        return ("<your-section>", "</your-section>")
 
-### Register Your Extensions
+    # Implement generate() and _format_rule()...
+```
 
-Add them to `sync_ai_rules/plugins.yaml`:
+3. **Register the pipeline** in `sync_ai_rules/plugins.yaml`:
 
 ```yaml
-parsers:
-  - name: your-format
-    module: your_parser
-    class: YourParser
-
-generators:
-  - name: your-output
-    module: your_generator
-    class: YourGenerator
+pipelines:
+  - name: your-pipeline
+    description: Your pipeline description
+    parser:
+      module: your_parser
+      class: YourParser
+    generator:
+      module: your_generator
+      class: YourGenerator
 ```
+
+Parsers and generators can be reused across multiple pipelines.