Вообще желательно, чтобы файл index.html лежал в корне папки. Название репозиториями должно быть строго таким: вашник.github.io Ну и не забывайте, что github pages поддерживает только статику, динамичную страницу он не отобразит.
Проект написан на nodejs и pug. Все файлы в папке docs. Когда открываю, то страница не найдена (404), что может быть не так?
github не умеет запускать nodejs приложения.
Точнее исходники можно сбилдить (естественно не во всех случаях) через gihub actions
и результат билда выкладывать в публичный доступ. Вот тут пример на основе react приложения