Skip to content

Commit ef1f6d0

Browse files
committed
Cleanup docs
1 parent 2ffc673 commit ef1f6d0

4 files changed

Lines changed: 5 additions & 12 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,9 @@ All `docker_image` entries found in `.pre-commit-config.yaml` will be included,
4545
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:
4646

4747
- **Development Rules** - from `.cursor/rules/*.mdc` files with YAML frontmatter
48-
- **Review Guidelines** - from `.code_review/*.md` files with HTML comment frontmatter
48+
- **Code Review Guidelines** - from `.code_review/*.md` files with HTML comment frontmatter
4949

50-
This ensures all AI coding assistants stay aware of the same rules and conventions.
50+
This ensures all AI coding assistants stay aware of the same rules and coding conventions.
5151

5252
## Usage
5353

sync_ai_rules/README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# sync-ai-rules
22

3-
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.
3+
Synchronizes AI rules to configuration files for Claude, GitHub Copilot, and other AI assistants. Parses rules from source directories and generates documentation sections automatically.
44

55
## Supported Formats
66

77
- **Development Rules** - `.cursor/rules/*.mdc` files (YAML frontmatter) → Development Rules section
8-
- **Review Guidelines** - `.code_review/*.md` files (HTML comment frontmatter) → Review Guidelines section
8+
- **Code Review Guidelines** - `.code_review/*.md` files (HTML comment frontmatter) → Code Review Guidelines section
99

1010
Target files: `CLAUDE.md`, `AGENTS.md`, `.github/copilot-instructions.md`
1111

@@ -16,9 +16,6 @@ Target files: `CLAUDE.md`, `AGENTS.md`, `.github/copilot-instructions.md`
1616
1. **Create a parser** in `sync_ai_rules/parsers/`:
1717

1818
```python
19-
from sync_ai_rules.core.parser_interface import InputParser
20-
from sync_ai_rules.core.rule_metadata import RuleMetadata
21-
2219
class YourParser(InputParser):
2320
@property
2421
def name(self) -> str:
@@ -34,8 +31,6 @@ class YourParser(InputParser):
3431
2. **Create a generator** in `sync_ai_rules/generators/`:
3532

3633
```python
37-
from sync_ai_rules.generators.base_generator import BaseGenerator
38-
3934
class YourGenerator(BaseGenerator):
4035
@property
4136
def name(self) -> str:

sync_ai_rules/file_updater.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,5 +90,5 @@ def update_documentation_file(
9090

9191
return True, f"Successfully {operation} rules section in {file_path}"
9292

93-
except (FileNotFoundError, PermissionError, UnicodeDecodeError, OSError) as e:
93+
except Exception as e:
9494
return False, f"Failed to update {file_path}: {e}"

sync_ai_rules/plugins.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
# Plugin configuration for sync_ai_rules
2-
# Define rule processing pipelines: each pipeline has a parser and generator.
3-
# Parsers and generators can be reused across multiple pipelines.
42

53
pipelines:
64
- name: development-rules

0 commit comments

Comments
 (0)