---
title: documentation-index-directory-missing
description: Reports a relevant child Documentation Directory omitted from its parent's Index Section.
---

[← All Rules](/rules/)

## What it does

Reports a direct child Documentation Directory whose required `README.md` entry is absent from the parent Index Section.

## Why it matters

Each index owns its direct children. A child directory entry is the route into that directory's own index and descendants.

## Examples

Given `docs/api/README.md` and `docs/api/intro.md`:

### Non-passing

```md title="AGENTS.md"
# Source Of Truth Map

- [Guide](docs/guide.md) — Load for contributor guidance.
```

### Passing

```md title="AGENTS.md"
# Source Of Truth Map

- [Guide](docs/guide.md) — Load for contributor guidance.
- [API](docs/api/README.md) — Load for API documentation.
```

## When it applies

This Rule belongs to the configurable `documentation-indexes` group and runs for enabled Index Policies. A child directory becomes relevant when it contains relevant documentation.

## References

See [Presswork Configuration](/configuration/#indexes) for Index Policies and [`src/check/evaluate-index.ts`](https://github.com/evilkiwi/presswork/blob/main/src/check/evaluate-index.ts) for directory ownership.
