Skip to content

Commit ddd7d6c

Browse files
docs: replace ASCII art with Mermaid diagrams, add diagram conventions
- Convert ASCII flowcharts in docs/README.md and design.md to Mermaid - Fix \n -> <br> in Mermaid node labels - Add Diagrams section to coding-standards.md: Mermaid only, <br> for line breaks Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent aee6374 commit ddd7d6c

3 files changed

Lines changed: 25 additions & 40 deletions

File tree

.agents/instructions/coding-standards.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ Rules selected: `E` (pycodestyle), `F` (pyflakes), `I` (isort), `N` (pep8-naming
3838

3939
No additional linters. Ruff is the single lint/format tool.
4040

41+
## Diagrams
42+
43+
Use Mermaid for all diagrams in documentation and design files:
44+
45+
- Use fenced ` ```mermaid ` blocks — never ASCII / box-art
46+
- Use `<br>` for line breaks inside node labels, not `\n`
47+
- File trees (directory listings) are the one exception — keep them as indented text
48+
4149
## Testing
4250

4351
pytest with standard conventions:

docs/README.md

Lines changed: 7 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,13 @@ iec-cli is a Python CLI tool that validates Intent Engineering practices in any
44

55
## Design
66

7-
```
8-
┌──────────┐ ┌─────────────────┐ ┌──────────────┐
9-
│ User │────▶│ iec-cli (CLI) │────▶│ Repo files │
10-
└──────────┘ └────────┬────────┘ └──────────────┘
11-
12-
┌────────▼────────┐
13-
│ Deterministic │
14-
│ checks (Python) │
15-
└────────┬────────┘
16-
17-
┌────────▼────────┐
18-
│ MCP Server │
19-
│ (agent-assisted) │
20-
└────────┬────────┘
21-
22-
┌────────▼────────┐
23-
│ User's agent │
24-
│ Agent (BYOK) │
25-
└─────────────────┘
7+
```mermaid
8+
flowchart LR
9+
User --> CLI["iec-cli (CLI)"]
10+
CLI --> Repo["Repo files"]
11+
CLI --> Det["Deterministic<br>checks (Python)"]
12+
Det --> MCP["MCP Server<br>(agent-assisted)"]
13+
MCP --> Agent["User's agent<br>(BYOK)"]
2614
```
2715

2816
## Two-Layer Check Architecture

openspec/changes/archive/2026-05-05-check/design.md

Lines changed: 10 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -98,27 +98,16 @@ Registry:
9898

9999
## Architecture
100100

101-
```
102-
iec check [--path <dir>]
103-
104-
105-
main.py: app.add_typer(check_app)
106-
107-
108-
check.py: check_app (Typer)
109-
110-
├── registry.run_all(Path) → list[CheckResult]
111-
│ │
112-
│ └── for each registered Checker:
113-
│ checker.check(path)
114-
115-
├── ResultCollector aggregates results
116-
│ ├── pass_count, warn_count, fail_count
117-
│ └── by_severity, by_checker groupings
118-
119-
└── Output formatter prints summary
120-
├── Per-checker: ✓ PASS / ⚠ WARN / ✗ FAIL
121-
└── Exit code: 0 (all pass), 1 (warnings), 2 (failures)
101+
```mermaid
102+
flowchart TD
103+
CMD["iec check [--path dir]"] --> Main["main.py<br>app.add_typer(check_app)"]
104+
Main --> App["check.py: check_app (Typer)"]
105+
App --> Registry["registry.run_all(Path) → list[CheckResult]"]
106+
Registry --> Checkers["for each Checker:<br>checker.check(path)"]
107+
App --> Collector["ResultCollector<br>pass_count / warn_count / fail_count<br>by_severity, by_checker"]
108+
App --> Formatter["Output formatter"]
109+
Formatter --> PerCheck["Per-checker: ✓ PASS / ⚠ WARN / ✗ FAIL"]
110+
Formatter --> Exit["Exit code: 0 all pass / 1 warnings / 2 failures"]
122111
```
123112

124113
## Risks / Trade-offs

0 commit comments

Comments
 (0)