Choosing README file for the repo front page


We have a and a for each project in our monorepo. That includes the .github directory, where we document changes to our GitHub Actions workflows and scripts.

The problem is that .github/ will shadow the in the repo root, which is an important piece of documentation.

We want to have documentation in both the root and the .github directory, but show the root one on the repo index page. Is there any way to solve this? Changing the order of preference perhaps.


I think the only way to do this is to rename the README in the .github folder.

Aight, that’s a bummer. We have automatic checks that verify README’s has been updated/reviewed each time a subdirectory has been changed. Renaming this file means we have to write special cases for that .github directory in our tooling.

No other ideas?