Skip to content

Commit 8d808ae

Browse files
authored
feat: Supersede ADR-0003 (#110)
1 parent 230e165 commit 8d808ae

5 files changed

Lines changed: 667 additions & 925 deletions

AGENTS.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@
1616
- **Index**:
1717
- [ADR-0001: Query Parser](docs/adr/ADR-0001-query-parser.md)
1818
- [ADR-0002: Diagnostics System](docs/adr/ADR-0002-diagnostics-system.md)
19-
- [ADR-0003: Query Intermediate Representation](docs/adr/ADR-0003-query-intermediate-representation.md)
19+
- ADR-0003: Query Intermediate Representation (superseded by ADR-0004, ADR-0005, ADR-0006, available via git history)
20+
- [ADR-0004: Query IR Binary Format](docs/adr/ADR-0004-query-ir-binary-format.md)
21+
- [ADR-0005: Transition Graph Format](docs/adr/ADR-0005-transition-graph-format.md)
22+
- [ADR-0006: Dynamic Query Execution](docs/adr/ADR-0006-dynamic-query-execution.md)
2023
- **Template**:
2124

2225
```markdown
@@ -40,6 +43,13 @@
4043
- **Considered Alternatives**: Describe rejected options and why.
4144
```
4245

46+
## How to write ADRs
47+
48+
ADRs must be succint and straight to the point.
49+
They must contain examples with high information density and pedagogical value.
50+
These are docs people usually don't want to read, but when they do, they find it quite fascinating.
51+
Avoid imperative code, describe structure definitions, their purpose and how to use them properly.
52+
4353
# Plotnik Query Language
4454

4555
Plotnik is a strongly-typed, whitespace-delimited pattern matching language for syntax trees (similar to Tree-sitter but stricter).

0 commit comments

Comments
 (0)