documentation-index-document-missing

Reports a required Index Document that does not exist.

← All Rules

What it does

Reports an absent configured root Index Document or an absent README.md required for a relevant descendant Documentation Directory.

Why it matters

Without the document, the directory has no Index Section to inventory its direct members.

Examples

Non-passing

AGENTS.md              # configured root Index Document
docs/
└── api/
    └── intro.md       # docs/api/README.md is absent

Passing

AGENTS.md
docs/
└── api/
    ├── README.md
    └── intro.md

When it applies

This Rule belongs to the configurable documentation-indexes group and runs for enabled Index Policies. A missing root index can instead be resolved by disabling that directory’s policy.

References

See Presswork Configuration for Index Documents and src/check/evaluate-index.ts for missing-document handling.