# In-repo documentation

This directory is reserved for in-repo docs that live alongside the source.
Currently it only holds this stub.

For project orientation, read [`../README.md`](../README.md). For a compact,
family-grouped index of all 514 indicators with one-line summaries and links
to each implementation file, read [`../INDICATORS.md`](../INDICATORS.md).

To regenerate `INDICATORS.md` after editing the indicator list:

```bash
python scripts/gen_indicators_index.py
```