Module template

One module or package: a folder, library or cohesive unit of code with a public interface. Lives at docs/repos/<repo>/modules/<page-slug>.md.

Generated by npm run new:page -- <repo> module <page-slug> "<Title>".

Template

---
title: "{{title}}"
description: "TODO: One sentence on what this module does."
status: draft
---

# {{title}}

TODO: One-sentence summary of the module.

| Field | Value |
| --- | --- |
| Source | `TODO: path/to/module` |
| Owner | TODO |
| Used by | TODO: modules, components or repositories that depend on it |

## Purpose

TODO: What problem this module solves and why it exists as a separate unit.

## Responsibilities

- TODO
- TODO

## Inputs / Parameters

TODO: What the module takes in: configuration, arguments, data it reads.

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| TODO | TODO | TODO | TODO |

## Outputs / Return value

TODO: What it exports or produces: public functions, classes, types, side
effects, data written.

| Export | Kind | Description |
| --- | --- | --- |
| TODO | function / class / type / constant | TODO |

## Usage

TODO: The smallest realistic example.

```js
// TODO: usage example
```

## Implementation

TODO: Add implementation details/code. Explain how it works and the parts that
aren't obvious from reading the code.

## Architecture

TODO: Add diagram or Mermaid diagram.

```mermaid
flowchart LR
  caller[TODO: Caller] --> mod["{{title}}"]
  mod --> dep1[TODO: Dependency]
  mod --> dep2[TODO: Dependency]
```

## Dependencies

| Dependency | Kind | Why it's needed |
| --- | --- | --- |
| TODO | internal / external | TODO |

## Edge cases

- TODO: Unusual inputs, failure modes, limits, and how the module behaves.

## Related components

- TODO: Links to related modules, components, functions or APIs.

Placeholders

{{title}}  Page title, usually the module name