Skip to content
Esc
navigateopen⌘Jpreview
On this page

documentation-index-entry-malformed

Reports one Index Section list item that identifies more than one relevant member.

← All Rules

What it does

Reports a list item containing links to multiple relevant direct members of the indexed directory.

Why it matters

Each inventory entry needs one member and its own loading guidance so ownership and duplication remain unambiguous.

Examples

Non-passing

# Source Of Truth Map

- [API](docs/api.md) and [Guide](docs/guide.md) — Load for product documentation.

Passing

# Source Of Truth Map

- [API](docs/api.md) — Load for the API contract.
- [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. Unrelated links in the section do not become inventory entries.

References

See Presswork Configuration for Index Sections and src/check/evaluate-index.ts for entry classification.