api docgen fixes

matifali · matifali · commit 8d9f35da4250 · 2024-08-13T09:38:49.000Z
diff --git a/docs/admin/automation.md b/docs/admin/automation.md
@@ -4,8 +4,8 @@ All actions possible through the Coder dashboard can also be automated as it
 utilizes the same public REST API. There are several ways to extend/automate
 Coder:
 
-- [CLI](../cli.md)
-- [REST API](../api/)
+- [CLI](../reference/cli/README.md)
+- [REST API](../reference/api/README.md)
 - [Coder SDK](https://pkg.go.dev/github.com/coder/coder/v2/codersdk)
 
 ## Quickstart
@@ -32,9 +32,10 @@ curl https://coder.example.com/api/v2/workspaces?q=owner:me \
 
 ## Documentation
 
-We publish an [API reference](../reference/api/README.md) in our documentation. You can
-also enable a [Swagger endpoint](../reference/cli/server.md#--swagger-enable) on
-your Coder deployment.
+We publish an [API reference](../reference/api/README.md) in our documentation.
+You can also enable a
+[Swagger endpoint](../reference/cli/server.md#--swagger-enable) on your Coder
+deployment.
 
 ## Use cases
 
@@ -52,8 +53,8 @@ payloads, we recommend checking the CLI and API documentation.
 Workspace agents have a special token that can send logs, metrics, and workspace
 activity.
 
-- [Custom workspace logs](../reference/api/agents.md#patch-workspace-agent-logs): Expose
-  messages prior to the Coder init script running (e.g. pulling image, VM
+- [Custom workspace logs](../reference/api/agents.md#patch-workspace-agent-logs):
+  Expose messages prior to the Coder init script running (e.g. pulling image, VM
   starting, restoring snapshot).
   [coder-logstream-kube](https://github.com/coder/coder-logstream-kube) uses
   this to show Kubernetes events, such as image pulls or ResourceQuota
diff --git a/docs/admin/healthcheck.md b/docs/admin/healthcheck.md
@@ -4,7 +4,8 @@ Coder includes an operator-friendly deployment health page that provides a
 number of details about the health of your Coder deployment.
 
 You can view it at `https://${CODER_URL}/health`, or you can alternatively view
-the [JSON response directly](../reference/api/debug.md#debug-info-deployment-health).
+the
+[JSON response directly](../reference/api/debug.md#debug-info-deployment-health).
 
 The deployment health page is broken up into the following sections:
 
diff --git a/docs/admin/provisioners.md b/docs/admin/provisioners.md
@@ -40,10 +40,10 @@ on the Coder server and start the provisioner with
 the [Helm example](#example-running-an-external-provisioner-with-helm) below.
 
 > Coder still supports authenticating the provisioner daemon with a
-> [token](../cli.md#--token) from a user with the Template Admin or Owner role.
-> This method is deprecated in favor of the PSK, which only has permission to
-> access provisioner daemon APIs. We recommend migrating to the PSK as soon as
-> practical.
+> [token](../reference/cli.md#--token) from a user with the Template Admin or
+> Owner role. This method is deprecated in favor of the PSK, which only has
+> permission to access provisioner daemon APIs. We recommend migrating to the
+> PSK as soon as practical.
 
 ## Types of provisioners
 
diff --git a/docs/admin/scaling/scale-testing.md b/docs/admin/scaling/scale-testing.md
@@ -112,13 +112,14 @@ on the workload size to ensure deployment stability.
 
 #### CPU and memory usage
 
-Enabling [agent stats collection](../../cli.md#--prometheus-collect-agent-stats)
+Enabling
+[agent stats collection](../../reference/cli.md#--prometheus-collect-agent-stats)
 (optional) may increase memory consumption.
 
 Enabling direct connections between users and workspace agents (apps or SSH
 traffic) can help prevent an increase in CPU usage. It is recommended to keep
-[this option enabled](../../cli.md#--disable-direct-connections) unless there
-are compelling reasons to disable it.
+[this option enabled](../../reference/cli.md#--disable-direct-connections)
+unless there are compelling reasons to disable it.
 
 Inactive users do not consume Coder resources.
 
diff --git a/docs/admin/workspace-proxies.md b/docs/admin/workspace-proxies.md
@@ -26,8 +26,8 @@ Workspace proxies can be used in the browser by navigating to the user
 
 ## Requirements
 
-- The [Coder CLI](../cli.md) must be installed and authenticated as a user with
-  the Owner role.
+- The [Coder CLI](../reference/cli.md) must be installed and authenticated as a
+  user with the Owner role.
 
 ## Step 1: Create the proxy
 
diff --git a/docs/reference/api/README.md b/docs/reference/api/README.md
diff --git a/docs/templates/agent-metadata.md b/docs/templates/agent-metadata.md
@@ -15,10 +15,10 @@ All of these examples use
 for the script declaration. With heredoc strings, you can script without messy
 escape codes, just as if you were working in your terminal.
 
-Some of the examples use the [`coder stat`](../reference/cli/stat.md) command. This is
-useful for determining CPU and memory usage of the VM or container that the
-workspace is running in, which is more accurate than resource usage about the
-workspace's host.
+Some of the examples use the [`coder stat`](../reference/cli/stat.md) command.
+This is useful for determining CPU and memory usage of the VM or container that
+the workspace is running in, which is more accurate than resource usage about
+the workspace's host.
 
 Here's a standard set of metadata snippets for Linux agents:
 
diff --git a/scripts/apidocgen/postprocess/main.go b/scripts/apidocgen/postprocess/main.go
@@ -38,12 +38,12 @@ curl https://coder.example.com/api/v2/workspaces?q=owner:me \
 
 ## Use cases
 
-See some common [use cases](../admin/automation.md#use-cases) for the REST API.
+See some common [use cases](../../admin/automation.md#use-cases) for the REST API.
 
 ## Sections
 
 <children>
-  This page is rendered on https://coder.com/docs/coder-oss/api. Refer to the other documents in the ` + "`api/`" + ` directory.
+  This page is rendered on https://coder.com/docs/reference/api. Refer to the other documents in the ` + "`api/`" + ` directory.
 </children>
 `
 )

Original file line number	Diff line number	Diff line change
`@@ -38,12 +38,12 @@ curl https://coder.example.com/api/v2/workspaces?q=owner:me \`
`38`	`38`
`39`	`39`	`## Use cases`
`40`	`40`
`41`		`-See some common [use cases](../admin/automation.md#use-cases) for the REST API.`
	`41`	`+See some common [use cases](../../admin/automation.md#use-cases) for the REST API.`
`42`	`42`
`43`	`43`	`## Sections`
`44`	`44`
`45`	`45`	`<children>`
`46`		- This page is rendered on https://coder.com/docs/coder-oss/api. Refer to the other documents in the ` + "`api/`" + ` directory.
	`46`	+ This page is rendered on https://coder.com/docs/reference/api. Refer to the other documents in the ` + "`api/`" + ` directory.
`47`	`47`	`</children>`
`48`	`48`	`
`49`	`49`	`)`