'Section index pages' selects 'README.md' as well as 'index.md'. But it is not documented

[ndy2]

Description

In the documentation of Section index pages feature, it says that index.md in respective folder would selected as a top level document for the folder. But I found that README.md also selected as a top level document.

with the feature navigation.indexes enabled

.folder
├── 1.md
├── 2.md
└── README.md

results in rendered navigation

.folder -> README.md
├── 1.md
└── 2.md

Related links

• https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#section-index-pages
• It is not a material's link but... https://www.mkdocs.org/user-guide/writing-your-docs/#index-pages

Proposed change

Add 'README.md' to Section index pages documentation.

I found that if both README.md and index.md supplied the README.md file get disappeared as documented in above mkdocs link. This is not specified to this feature, but I think it can be documented here.

Before submitting

• I have read and followed the documentation issue reporting guidelines.
• I have attached the links to the described sections of the documentation

[squidfunk]

Thanks for reporting! Added in f3ae326 as a code annotation.