rebase on main

matifali · matifali · commit fc159ced858a · 2024-08-12T17:01:25.000+03:00
diff --git a/Makefile b/Makefile
@@ -489,7 +489,7 @@ gen: \
 	codersdk/rbacresources_gen.go \
 	site/src/api/rbacresources_gen.ts \
 	docs/admin/prometheus.md \
-	docs/cli.md \
+	docs/reference/cli/README.md \
 	docs/admin/audit-logs.md \
 	coderd/apidoc/swagger.json \
 	.prettierignore.include \
@@ -521,7 +521,7 @@ gen/mark-fresh:
 		codersdk/rbacresources_gen.go \
 		site/src/api/rbacresources_gen.ts \
 		docs/admin/prometheus.md \
-		docs/cli.md \
+		docs/reference/cli/README.md \
 		docs/admin/audit-logs.md \
 		coderd/apidoc/swagger.json \
 		.prettierignore.include \
@@ -633,10 +633,10 @@ docs/admin/prometheus.md: scripts/metricsdocgen/main.go scripts/metricsdocgen/me
 	./scripts/pnpm_install.sh
 	pnpm exec prettier --write ./docs/admin/prometheus.md
 
-docs/cli.md: scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES)
+docs/reference/cli/README.md: scripts/clidocgen/main.go examples/examples.gen.json $(GO_SRC_FILES)
 	CI=true BASE_PATH="." go run ./scripts/clidocgen
 	./scripts/pnpm_install.sh
-	pnpm exec prettier --write ./docs/cli.md ./docs/cli/*.md ./docs/manifest.json
+	pnpm exec prettier --write ./docs/reference/cli/README.md ./docs/cli/reference/cli/*.md ./docs/manifest.json
 
 docs/admin/audit-logs.md: coderd/database/querier.go scripts/auditdocgen/main.go enterprise/audit/table.go coderd/rbac/object_gen.go
 	go run scripts/auditdocgen/main.go
diff --git a/docs/manifest.json b/docs/manifest.json
@@ -350,7 +350,7 @@
         {
           "title": "REST API",
           "description": "Learn how to use Coderd API",
-          "path": "./reference/api/index.md",
+          "path": "./reference/api/README.md",
           "icon_path": "./images/icons/api.svg",
           "children": [
             {
diff --git a/docs/reference/api/README.md b/docs/reference/api/README.md
diff --git a/scripts/apidocgen/postprocess/main.go b/scripts/apidocgen/postprocess/main.go
@@ -16,8 +16,8 @@ import (
 )
 
 const (
-	apiSubdir       = "api"
-	apiIndexFile    = "index.md"
+	apiSubdir       = "reference/api"
+	apiIndexFile    = "README.md"
 	apiIndexContent = `Get started with the Coder API:
 
 ## Quickstart
diff --git a/scripts/clidocgen/gen.go b/scripts/clidocgen/gen.go
@@ -77,7 +77,7 @@ func fullName(cmd *serpent.Command) string {
 func fmtDocFilename(cmd *serpent.Command) string {
 	if cmd.FullName() == "coder" {
 		// Special case for index.
-		return "../cli.md"
+		return "./README.md"
 	}
 	name := strings.ReplaceAll(fullName(cmd), " ", "_")
 	return fmt.Sprintf("%s.md", name)

Original file line number	Diff line number	Diff line change
`@@ -350,7 +350,7 @@`
`350`	`350`	`{`
`351`	`351`	`"title": "REST API",`
`352`	`352`	`"description": "Learn how to use Coderd API",`
`353`		`- "path": "./reference/api/index.md",`
	`353`	`+ "path": "./reference/api/README.md",`
`354`	`354`	`"icon_path": "./images/icons/api.svg",`
`355`	`355`	`"children": [`
`356`	`356`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,8 @@ import (`
`16`	`16`	`)`
`17`	`17`
`18`	`18`	`const (`
`19`		`- apiSubdir = "api"`
`20`		`- apiIndexFile = "index.md"`
	`19`	`+ apiSubdir = "reference/api"`
	`20`	`+ apiIndexFile = "README.md"`
`21`	`21`	apiIndexContent = `Get started with the Coder API:
`22`	`22`
`23`	`23`	`## Quickstart`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ func fullName(cmd *serpent.Command) string {`
`77`	`77`	`func fmtDocFilename(cmd *serpent.Command) string {`
`78`	`78`	`if cmd.FullName() == "coder" {`
`79`	`79`	`// Special case for index.`
`80`		`- return "../cli.md"`
	`80`	`+ return "./README.md"`
`81`	`81`	`}`
`82`	`82`	`name := strings.ReplaceAll(fullName(cmd), " ", "_")`
`83`	`83`	`return fmt.Sprintf("%s.md", name)`