Update API and CLI documentation index filenames

matifali · matifali · commit efd4294346df · 2024-10-04T21:55:00.000Z
Refactor the index filenames in the API and CLI documentation
generation scripts from `README.md` to `index.md` for consistency
with modern documentation standards.
diff --git a/scripts/apidocgen/postprocess/main.go b/scripts/apidocgen/postprocess/main.go
@@ -17,7 +17,7 @@ import (
 
 const (
 	apiSubdir       = "reference/api"
-	apiIndexFile    = "README.md"
+	apiIndexFile    = "index.md"
 	apiIndexContent = `Get started with the Coder API:
 
 ## Quickstart
@@ -38,7 +38,7 @@ curl https://coder.example.com/api/v2/workspaces?q=owner:me \
 
 ## Use cases
 
-See some common [use cases](../../reference/README.md#use-cases) for the REST API.
+See some common [use cases](../../reference/index.md#use-cases) for the REST API.
 
 ## Sections
 
diff --git a/scripts/clidocgen/gen.go b/scripts/clidocgen/gen.go
@@ -87,7 +87,7 @@ func fullName(cmd *serpent.Command) string {
 func fmtDocFilename(cmd *serpent.Command) string {
 	if cmd.FullName() == "coder" {
 		// Special case for index.
-		return "./README.md"
+		return "./index.md"
 	}
 	name := strings.ReplaceAll(fullName(cmd), " ", "_")
 	return fmt.Sprintf("%s.md", name)

Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ func fullName(cmd *serpent.Command) string {`
`87`	`87`	`func fmtDocFilename(cmd *serpent.Command) string {`
`88`	`88`	`if cmd.FullName() == "coder" {`
`89`	`89`	`// Special case for index.`
`90`		`- return "./README.md"`
	`90`	`+ return "./index.md"`
`91`	`91`	`}`
`92`	`92`	`name := strings.ReplaceAll(fullName(cmd), " ", "_")`
`93`	`93`	`return fmt.Sprintf("%s.md", name)`