feat(backend): Support README files in the docs directory

Many other Git platforms support it as well.
charmbracelet · Jan 15, 2025 · dc0fab6 · dc0fab6
1 parent 22d00e9
commit dc0fab6
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/pkg/backend/utils.go b/pkg/backend/utils.go
@@ -1,6 +1,8 @@
 package backend
 
 import (
+	"fmt"
+
 	"github.com/charmbracelet/soft-serve/git"
 	"github.com/charmbracelet/soft-serve/pkg/proto"
 )
@@ -19,5 +21,9 @@ func LatestFile(r proto.Repository, ref *git.Reference, pattern string) (string,
 func Readme(r proto.Repository, ref *git.Reference) (readme string, path string, err error) {
 	pattern := "[rR][eE][aA][dD][mM][eE]*"
 	readme, path, err = LatestFile(r, ref, pattern)
+	if err != nil {
+		pattern := fmt.Sprintf("docs/%s", pattern)
+		readme, path, err = LatestFile(r, ref, pattern)
+	}
 	return
 }