Skip to content

Commit f97cb47

Browse files
iavclaude
authored andcommitted
docs: exclude docs/README.md from mkdocs build
docs/README.md is a folder placeholder for GitHub's directory listing. mkdocs treats it as a second index page for docs/ and drops it with a warning, which aborts `mkdocs build --strict`. Exclude it explicitly via exclude_docs so strict builds pass cleanly while the file stays in the repository for GitHub's folder view. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 36c70ba commit f97cb47

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

mkdocs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ repo_url: https://github.com/armbian/documentation
88
edit_uri: edit/main/docs/
99
repo_name: armbian/documentation
1010

11+
# docs/README.md is a folder placeholder for GitHub's directory view; it
12+
# collides with index.md as the site home. Exclude it from the build so
13+
# `mkdocs build --strict` does not abort on the conflict warning.
14+
exclude_docs: |
15+
/README.md
16+
1117
theme:
1218
name: material
1319
custom_dir: overrides

0 commit comments

Comments
 (0)