Architecture template

How one repository is structured internally and how it fits into the rest of Ediky, at docs/repos/<repo>/architecture.md. The diagrams are placeholders. Replace the TODO nodes with the real ones, or swap in an exported image.

Generated by npm run new:repo.

Template

---
title: "Architecture"
description: "How {{repoName}} is structured and how its parts interact."
status: draft
---

# {{repoName}} architecture

TODO: One paragraph: the shape of this repository in plain words. What runs,
where, and what it talks to.

## System context

TODO: Where this repository sits relative to users, other Ediky repositories
and external services.

```mermaid
flowchart LR
  user([TODO: User or caller]) --> repo["{{repoName}}"]
  repo --> store[(TODO: Data store)]
  repo --> ext[TODO: External service]
  other[TODO: Other Ediky repository] -.-> repo
```

## Internal structure

TODO: The major layers or modules and what each is responsible for. Link each
one to its page under [Modules](./modules/).

```mermaid
flowchart TD
  entry[TODO: Entry point] --> a[TODO: Layer or module]
  a --> b[TODO: Layer or module]
  a --> c[TODO: Layer or module]
```

| Part | Responsibility | Docs |
| --- | --- | --- |
| TODO | TODO | TODO: link |

## Key flows

TODO: The two or three flows that matter most (a request, a job, a build).
Add one sequence diagram for each.

### TODO: Flow name

```mermaid
sequenceDiagram
  participant A as TODO: Caller
  participant B as {{repoName}}
  participant C as TODO: Dependency
  A->>B: TODO: request
  B->>C: TODO: call
  C-->>B: TODO: result
  B-->>A: TODO: response
```

## Data and state

TODO: What data this repository owns, where it lives, and who else reads or
writes it.

## Design decisions

| Decision | Why | Alternatives considered |
| --- | --- | --- |
| TODO | TODO | TODO |

## Constraints and trade-offs

TODO: Known limits, accepted trade-offs, and what would change them.

## Related

- [Modules](./modules/)
- [Dependencies](./dependencies)
- [Overall Ediky architecture](/cross-repo/architecture)

Placeholders

{{repoName}}  Display name of the repository