Files
wsg/docs/rules/fragments/11_IndexFiles.md
T
Jérôme Bousquié 37432536dc refactor spec OKF
2026-08-01 09:34:12 +02:00

25 lines
472 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
---
type: Section
title: Index Files
sources: [SPEC.md]
generated: true
verified: false
status: current
stale_after: 2026-12-31
---
# Index Files
An `index.md` file at the root of a bundle lists the concepts it contains. It provides a table of contents for humans and a machinereadable list for tools.
## Example
```markdown
# Index
- [Concept A](@/concepts/a)
- [Concept B](@/concepts/b)
```
Index files should be kept in sync with the bundle's actual contents.