Skip to content
Esc
navigateopen⌘Jpreview
On this page

documentation-index-member-wrong-target

Reports an index entry whose target does not match the member it identifies.

← All Rules

What it does

Reports a member label linked to a different member, or a child Documentation Directory linked as directory shorthand instead of through its README.md.

Why it matters

The link text and destination need to identify the same direct member and route child directories through their own index.

Examples

Non-passing

# Source Of Truth Map

- [Guide](docs/api.md) — Load for contributor guidance.
- [Architecture notes](docs/architecture) — Load for architecture.

Passing

# Source Of Truth Map

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

When it applies

This Rule belongs to the configurable documentation-indexes group and runs for enabled Index Policies. Member labels include a document’s basename, stem, and repository-relative path.

References

See Presswork Configuration for Index Sections and src/check/evaluate-index.ts for target matching.