documentation-index-member-undescribed

Reports an index member without meaningful authored loading guidance.

← All Rules

What it does

Reports a valid member link whose containing list item has no authored letter or number outside the link.

Why it matters

An Index Section tells readers both what exists and when to load each document or child directory index.

Examples

Non-passing

# Source Of Truth Map

- [API](docs/api.md)

Passing

# Source Of Truth Map

- [API](docs/api.md) — Load when changing the public API.

When it applies

This Rule belongs to the configurable documentation-indexes group and runs for enabled Index Policies. Guidance must be authored outside the member-identifying link.

References

See Concepts for Index Sections and src/check/evaluate-index.ts for meaningful-guidance evaluation.