jerb 0.0.0-reserved

Coming Soon
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27

# Documentation Templates

This directory contains templates for various documentation types used in the Jerb project.

## Architecture Decision Records (ADRs)

Use `adr.md` as the template for creating new Architecture Decision Records.

### Creating a New ADR

1. Copy the ADR template to `docs/adr/`:

    ```sh
    cp docs/templates/adr.md docs/adr/XXXX-your-decision-title.md
    ```

2. Replace `XXXX` with the next sequential number (zero-padded to 4 digits)

3. Fill in all sections of the template

### ADR Naming Convention

ADRs should follow this naming pattern:

```plaintext
XXXX-short-kebab-case-title.md
```