documentation-index-section-missing

Reports an Index Document without its configured Index Section heading.

← All Rules

What it does

Reports an eligible Index Document that contains no heading with the Index Policy’s configured text.

Why it matters

The configured heading marks the authored section that inventories the directory’s direct members.

Examples

For a policy whose heading is Source Of Truth Map:

Non-passing

# Other

Passing

# Source Of Truth Map

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

When it applies

This Rule belongs to the configurable documentation-indexes group and runs for enabled Index Policies.

References

See Presswork Configuration for the configured heading and src/check/evaluate-index.ts for section selection.