From 19c33db4f85bf177f2ce43f52fce8f88d1889001 Mon Sep 17 00:00:00 2001 From: Nick Vigilante Date: Tue, 11 Aug 2026 16:58:58 +0000 Subject: [PATCH 1/2] docs: add front-matter titles to mechanical and no-H1 pages (Phase 3) Batch A of the Phase 3 H1 to front-matter migration (DOCS-484, parent DOCS-477). Adds a front-matter title to the 138 pages whose leading body H1 already equals the manifest nav label (dropping that now-duplicate H1) and to the 4 pages that render under a manifest label with no body H1. Rendered no-op: the renderers already prefer the manifest title and hide the body H1 (Phase 1), so no page changes visually. Reference pages (already front-matter-aware via Phase 2 generators) and the 126 pages whose body H1 differs from the manifest label (editorial reconciliation) are out of scope for this batch. --- docs/README.md | 4 +++- docs/about/contributing/AI_CONTRIBUTING.md | 4 +++- docs/about/contributing/CONTRIBUTING.md | 4 +++- docs/about/contributing/backend.md | 4 +++- docs/about/contributing/documentation.md | 4 +++- docs/about/contributing/frontend.md | 4 +++- docs/about/screenshots.md | 4 +++- docs/admin/external-auth/index.md | 4 +++- docs/admin/index.md | 4 +++- docs/admin/infrastructure/architecture.md | 4 +++- docs/admin/infrastructure/index.md | 4 +++- docs/admin/infrastructure/scale-testing.md | 4 +++- .../integrations/devcontainers/envbuilder/add-envbuilder.md | 4 +++- docs/admin/integrations/devcontainers/envbuilder/index.md | 4 +++- docs/admin/integrations/devcontainers/index.md | 4 +++- docs/admin/integrations/index.md | 4 +++- docs/admin/integrations/platformx.md | 4 +++- docs/admin/integrations/prometheus.md | 4 +++- docs/admin/licensing/index.md | 4 +++- docs/admin/monitoring/logs.md | 4 +++- docs/admin/monitoring/notifications/index.md | 4 +++- docs/admin/monitoring/notifications/slack.md | 4 +++- docs/admin/monitoring/notifications/teams.md | 4 +++- docs/admin/networking/high-availability.md | 4 +++- docs/admin/networking/index.md | 4 +++- docs/admin/networking/port-forwarding.md | 4 +++- docs/admin/networking/stun.md | 4 +++- docs/admin/networking/troubleshooting.md | 4 +++- docs/admin/security/database-encryption.md | 4 +++- docs/admin/security/index.md | 4 +++- docs/admin/security/secrets.md | 4 +++- docs/admin/setup/data-retention.md | 4 +++- docs/admin/setup/telemetry.md | 4 +++- docs/admin/templates/creating-templates.md | 4 +++- docs/admin/templates/extending-templates/devcontainers.md | 4 +++- .../templates/extending-templates/docker-in-workspaces.md | 4 +++- .../templates/extending-templates/dynamic-parameters.md | 4 +++- docs/admin/templates/extending-templates/icons.md | 4 +++- .../templates/extending-templates/prebuilt-workspaces.md | 4 +++- .../admin/templates/extending-templates/process-priority.md | 4 +++- .../extending-templates/provider-authentication.md | 4 +++- .../templates/extending-templates/resource-metadata.md | 4 +++- docs/admin/templates/extending-templates/workspace-tags.md | 4 +++- docs/admin/templates/managing-templates/dependencies.md | 4 +++- docs/admin/templates/managing-templates/envbuilder.md | 4 +++- .../templates/managing-templates/external-workspaces.md | 4 +++- docs/admin/templates/managing-templates/image-management.md | 4 +++- docs/admin/templates/managing-templates/schedule.md | 4 +++- docs/admin/templates/open-in-coder.md | 4 +++- docs/admin/users/headless-auth.md | 4 +++- docs/admin/users/idp-sync.md | 6 ++++-- docs/admin/users/index.md | 4 +++- docs/admin/users/oidc-auth/refresh-tokens.md | 4 +++- docs/admin/users/password-auth.md | 4 +++- docs/admin/users/quotas.md | 4 +++- docs/ai-coder/agent-firewall/index.md | 4 +++- docs/ai-coder/agents/architecture.md | 4 +++- docs/ai-coder/agents/chat-sharing.md | 4 +++- docs/ai-coder/agents/extending-agents.md | 4 +++- docs/ai-coder/agents/getting-started.md | 4 +++- docs/ai-coder/agents/index.md | 4 +++- docs/ai-coder/agents/models.md | 4 +++- docs/ai-coder/agents/platform-controls/advisor.md | 4 +++- .../ai-coder/agents/platform-controls/chat-debug-logging.md | 4 +++- docs/ai-coder/agents/platform-controls/git-providers.md | 4 +++- docs/ai-coder/agents/platform-controls/index.md | 4 +++- docs/ai-coder/agents/platform-controls/mcp-servers.md | 4 +++- .../agents/platform-controls/template-optimization.md | 4 +++- docs/ai-coder/agents/platform-controls/virtual-desktop.md | 4 +++- docs/ai-coder/agents/tools/index.md | 4 +++- docs/ai-coder/ai-gateway/ai-gateway-proxy/index.md | 4 +++- docs/ai-coder/ai-gateway/ai-gateway-proxy/setup.md | 4 +++- docs/ai-coder/ai-gateway/audit.md | 4 +++- docs/ai-coder/ai-gateway/auth.md | 4 +++- docs/ai-coder/ai-gateway/clients/claude-code.md | 4 +++- docs/ai-coder/ai-gateway/clients/cline.md | 4 +++- docs/ai-coder/ai-gateway/clients/copilot.md | 4 +++- docs/ai-coder/ai-gateway/clients/factory.md | 4 +++- docs/ai-coder/ai-gateway/clients/index.md | 4 +++- docs/ai-coder/ai-gateway/clients/kilo-code.md | 4 +++- docs/ai-coder/ai-gateway/clients/mux.md | 4 +++- docs/ai-coder/ai-gateway/clients/opencode.md | 4 +++- docs/ai-coder/ai-gateway/clients/vscode.md | 3 +++ docs/ai-coder/ai-gateway/clients/zed.md | 4 +++- docs/ai-coder/ai-gateway/cost-controls.md | 4 +++- docs/ai-coder/ai-gateway/index.md | 4 +++- docs/ai-coder/ai-gateway/monitoring.md | 4 +++- docs/ai-coder/ai-gateway/providers.md | 4 +++- docs/ai-coder/ai-gateway/rebranding-migration.md | 4 +++- docs/ai-coder/ai-gateway/reference.md | 4 +++- docs/ai-coder/ai-gateway/setup.md | 4 +++- docs/ai-coder/ai-governance.md | 4 +++- docs/ai-coder/best-practices.md | 4 +++- docs/ai-coder/custom-agents.md | 4 +++- docs/ai-coder/ide-agents.md | 4 ++++ docs/ai-coder/index.md | 4 +++- docs/ai-coder/mcp-server.md | 4 +++- docs/ai-coder/security.md | 4 ++++ docs/ai-coder/tasks-core-principles.md | 4 +++- docs/ai-coder/tasks.md | 4 +++- docs/ai-coder/usage-data-reporting.md | 4 +++- .../customize-your-template/authenticate-to-github.md | 4 +++- docs/get-started/customize-your-template/index.md | 4 +++- .../customize-your-template/install-command-line-tools.md | 4 +++- docs/install/airgap.md | 4 +++- docs/install/kubernetes/kubernetes-azure-app-gateway.md | 4 +++- docs/install/openshift.md | 4 +++- docs/install/releases/esr-2.24-2.29-upgrade.md | 4 +++- docs/install/releases/esr-2.29-2.34-upgrade.md | 4 +++- docs/install/releases/feature-stages.md | 4 +++- docs/install/releases/index.md | 4 +++- docs/install/uninstall.md | 6 ++++-- docs/install/upgrade-best-practices.md | 4 +++- docs/reference/agent-api/debug.md | 4 +++- docs/reference/agent-api/schemas.md | 4 +++- docs/reference/glossary.md | 4 +++- docs/reference/index.md | 4 +++- docs/support/index.md | 4 +++- docs/tutorials/best-practices/index.md | 4 +++- docs/tutorials/best-practices/organizations.md | 4 +++- docs/tutorials/best-practices/security-best-practices.md | 4 +++- docs/tutorials/cloning-git-repositories.md | 4 +++- docs/tutorials/faqs.md | 4 +++- docs/user-guides/desktop/desktop-connect-sync.md | 4 +++- docs/user-guides/desktop/index.md | 4 +++- .../user-guides/devcontainers/customizing-dev-containers.md | 4 +++- docs/user-guides/devcontainers/index.md | 4 +++- .../devcontainers/troubleshooting-dev-containers.md | 4 +++- docs/user-guides/index.md | 4 +++- docs/user-guides/user-secrets.md | 4 +++- docs/user-guides/workspace-access/antigravity.md | 4 +++- docs/user-guides/workspace-access/code-server.md | 4 +++- docs/user-guides/workspace-access/cursor.md | 4 +++- docs/user-guides/workspace-access/emacs-tramp.md | 4 +++- docs/user-guides/workspace-access/jetbrains/fleet.md | 4 +++- docs/user-guides/workspace-access/jetbrains/gateway.md | 4 ++++ docs/user-guides/workspace-access/jetbrains/index.md | 4 +++- docs/user-guides/workspace-access/vscode.md | 4 +++- docs/user-guides/workspace-access/web-terminal.md | 4 +++- docs/user-guides/workspace-access/windsurf.md | 4 +++- docs/user-guides/workspace-access/zed.md | 4 +++- docs/user-guides/workspace-dotfiles.md | 4 +++- 142 files changed, 431 insertions(+), 140 deletions(-) diff --git a/docs/README.md b/docs/README.md index 96f4ed49565..0d89264f19f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,6 @@ -# About +--- +title: About +--- diff --git a/docs/about/contributing/AI_CONTRIBUTING.md b/docs/about/contributing/AI_CONTRIBUTING.md index 8771528f0c1..a2b880a6bd8 100644 --- a/docs/about/contributing/AI_CONTRIBUTING.md +++ b/docs/about/contributing/AI_CONTRIBUTING.md @@ -1,4 +1,6 @@ -# AI Contribution Guidelines +--- +title: AI Contribution Guidelines +--- This document defines rules for contributions where an AI system is the primary author of the code (i.e., most of the pull request was generated by AI). It applies to all Coder repositories and is a supplement to the [existing contributing guidelines](./CONTRIBUTING.md), not a replacement. diff --git a/docs/about/contributing/CONTRIBUTING.md b/docs/about/contributing/CONTRIBUTING.md index cfca7af52ce..5f5dfd4cc10 100644 --- a/docs/about/contributing/CONTRIBUTING.md +++ b/docs/about/contributing/CONTRIBUTING.md @@ -1,4 +1,6 @@ -# Contributing +--- +title: Contributing +--- ## Requirements diff --git a/docs/about/contributing/backend.md b/docs/about/contributing/backend.md index ea87a9a6661..4851855567e 100644 --- a/docs/about/contributing/backend.md +++ b/docs/about/contributing/backend.md @@ -1,4 +1,6 @@ -# Backend +--- +title: Backend +--- This guide is designed to support both Coder engineers and community contributors in understanding our backend systems and getting started with development. diff --git a/docs/about/contributing/documentation.md b/docs/about/contributing/documentation.md index 7c492590522..a156e8567f9 100644 --- a/docs/about/contributing/documentation.md +++ b/docs/about/contributing/documentation.md @@ -1,4 +1,6 @@ -# Documentation +--- +title: Documentation +--- This style guide is primarily for use with authoring documentation. diff --git a/docs/about/contributing/frontend.md b/docs/about/contributing/frontend.md index 731055af5c9..c9391574bfc 100644 --- a/docs/about/contributing/frontend.md +++ b/docs/about/contributing/frontend.md @@ -1,4 +1,6 @@ -# Frontend +--- +title: Frontend +--- Welcome to the guide for contributing to the Coder frontend. Whether you’re part of the community or a Coder team member, this documentation will help you get diff --git a/docs/about/screenshots.md b/docs/about/screenshots.md index d0a0591c819..d471b1148f3 100644 --- a/docs/about/screenshots.md +++ b/docs/about/screenshots.md @@ -1,4 +1,6 @@ -# Screenshots +--- +title: Screenshots +--- ## Log in diff --git a/docs/admin/external-auth/index.md b/docs/admin/external-auth/index.md index bb271a82f15..4c20f78948c 100644 --- a/docs/admin/external-auth/index.md +++ b/docs/admin/external-auth/index.md @@ -1,4 +1,6 @@ -# External Authentication +--- +title: External Authentication +--- Coder supports external authentication via OAuth2.0. This allows enabling any OAuth provider as well as integrations with Git providers, such as GitHub, GitLab, and Bitbucket. diff --git a/docs/admin/index.md b/docs/admin/index.md index 2bb7f0ebd3b..be27accb157 100644 --- a/docs/admin/index.md +++ b/docs/admin/index.md @@ -1,4 +1,6 @@ -# Administration +--- +title: Administration +--- ![Admin settings general page](../images/admin/admin-settings-general.png) diff --git a/docs/admin/infrastructure/architecture.md b/docs/admin/infrastructure/architecture.md index 79b709a6e91..d8391041575 100644 --- a/docs/admin/infrastructure/architecture.md +++ b/docs/admin/infrastructure/architecture.md @@ -1,4 +1,6 @@ -# Architecture +--- +title: Architecture +--- The Coder deployment model is flexible and offers various components that platform administrators can deploy and scale depending on their use case. This diff --git a/docs/admin/infrastructure/index.md b/docs/admin/infrastructure/index.md index 5c2233625f6..732c3fccf5e 100644 --- a/docs/admin/infrastructure/index.md +++ b/docs/admin/infrastructure/index.md @@ -1,4 +1,6 @@ -# Infrastructure +--- +title: Infrastructure +--- Learn how to spin up & manage Coder infrastructure. diff --git a/docs/admin/infrastructure/scale-testing.md b/docs/admin/infrastructure/scale-testing.md index bbfbb35309e..5401ca94bb8 100644 --- a/docs/admin/infrastructure/scale-testing.md +++ b/docs/admin/infrastructure/scale-testing.md @@ -1,4 +1,6 @@ -# Scale Testing +--- +title: Scale Testing +--- Scaling Coder involves planning and testing to ensure it can handle more load without compromising service. This process encompasses infrastructure setup, diff --git a/docs/admin/integrations/devcontainers/envbuilder/add-envbuilder.md b/docs/admin/integrations/devcontainers/envbuilder/add-envbuilder.md index 59f6b3691d2..c520bef492e 100644 --- a/docs/admin/integrations/devcontainers/envbuilder/add-envbuilder.md +++ b/docs/admin/integrations/devcontainers/envbuilder/add-envbuilder.md @@ -1,4 +1,6 @@ -# Add an Envbuilder template +--- +title: Add an Envbuilder template +--- A Coder administrator adds an Envbuilder-compatible template to Coder. This allows the template to prompt the developer for their dev container repository's diff --git a/docs/admin/integrations/devcontainers/envbuilder/index.md b/docs/admin/integrations/devcontainers/envbuilder/index.md index 9b4bc0c9dfd..f2a69476053 100644 --- a/docs/admin/integrations/devcontainers/envbuilder/index.md +++ b/docs/admin/integrations/devcontainers/envbuilder/index.md @@ -1,4 +1,6 @@ -# Envbuilder +--- +title: Envbuilder +--- Envbuilder is an open-source tool that builds development environments from [dev container](https://containers.dev/implementors/spec/) configuration files. diff --git a/docs/admin/integrations/devcontainers/index.md b/docs/admin/integrations/devcontainers/index.md index 4ffbca2145b..6d16b90633a 100644 --- a/docs/admin/integrations/devcontainers/index.md +++ b/docs/admin/integrations/devcontainers/index.md @@ -1,4 +1,6 @@ -# Dev Containers +--- +title: Dev Containers +--- Dev containers allow developers to define their development environment as code using the [Dev Container specification](https://containers.dev/). diff --git a/docs/admin/integrations/index.md b/docs/admin/integrations/index.md index 3a1a11f2448..0e73e3c1115 100644 --- a/docs/admin/integrations/index.md +++ b/docs/admin/integrations/index.md @@ -1,4 +1,6 @@ -# Integrations +--- +title: Integrations +--- Coder is highly extensible and is not limited to the platforms outlined in these docs. The control plane can be provisioned on any VM or container compute, and diff --git a/docs/admin/integrations/platformx.md b/docs/admin/integrations/platformx.md index 207087b2356..43f37efb791 100644 --- a/docs/admin/integrations/platformx.md +++ b/docs/admin/integrations/platformx.md @@ -1,4 +1,6 @@ -# DX PlatformX +--- +title: DX PlatformX +--- [DX](https://getdx.com) is a developer intelligence platform used by engineering leaders and platform engineers. Coder notifications can be transformed to diff --git a/docs/admin/integrations/prometheus.md b/docs/admin/integrations/prometheus.md index 2d418b34a0b..fabae1043b3 100644 --- a/docs/admin/integrations/prometheus.md +++ b/docs/admin/integrations/prometheus.md @@ -1,4 +1,6 @@ -# Prometheus +--- +title: Prometheus +--- Coder exposes many metrics which can be consumed by a Prometheus server, and give insight into the current state of a live Coder deployment. diff --git a/docs/admin/licensing/index.md b/docs/admin/licensing/index.md index 6031a68c740..e27df80c0d6 100644 --- a/docs/admin/licensing/index.md +++ b/docs/admin/licensing/index.md @@ -1,4 +1,6 @@ -# Licensing +--- +title: Licensing +--- Some features are only accessible with a Premium license, including [AI Governance](../../ai-coder/ai-governance.md). See our diff --git a/docs/admin/monitoring/logs.md b/docs/admin/monitoring/logs.md index 7e4c27154c4..241b11dd08f 100644 --- a/docs/admin/monitoring/logs.md +++ b/docs/admin/monitoring/logs.md @@ -1,4 +1,6 @@ -# Logs +--- +title: Logs +--- All Coder services log to standard output, which can be critical for identifying errors and monitoring Coder's deployment health. Like any service, logs can be diff --git a/docs/admin/monitoring/notifications/index.md b/docs/admin/monitoring/notifications/index.md index 8a01d066fff..9a58ebe7be2 100644 --- a/docs/admin/monitoring/notifications/index.md +++ b/docs/admin/monitoring/notifications/index.md @@ -1,4 +1,6 @@ -# Notifications +--- +title: Notifications +--- Notifications are sent by Coder in response to specific internal events, such as a workspace being deleted or a user being created. diff --git a/docs/admin/monitoring/notifications/slack.md b/docs/admin/monitoring/notifications/slack.md index 7509c1fbad2..b9b6e45054a 100644 --- a/docs/admin/monitoring/notifications/slack.md +++ b/docs/admin/monitoring/notifications/slack.md @@ -1,4 +1,6 @@ -# Slack Notifications +--- +title: Slack Notifications +--- [Slack](https://slack.com/) is a popular messaging platform designed for teams and businesses, enabling real-time collaboration through channels, direct diff --git a/docs/admin/monitoring/notifications/teams.md b/docs/admin/monitoring/notifications/teams.md index 396ef80df41..0510520ac8d 100644 --- a/docs/admin/monitoring/notifications/teams.md +++ b/docs/admin/monitoring/notifications/teams.md @@ -1,4 +1,6 @@ -# Microsoft Teams Notifications +--- +title: Microsoft Teams Notifications +--- [Microsoft Teams](https://www.microsoft.com/en-us/microsoft-teams) is a widely used collaboration platform, and with Coder's integration, you can enable diff --git a/docs/admin/networking/high-availability.md b/docs/admin/networking/high-availability.md index 292309d44ca..ea2f626feb5 100644 --- a/docs/admin/networking/high-availability.md +++ b/docs/admin/networking/high-availability.md @@ -1,4 +1,6 @@ -# High Availability +--- +title: High Availability +--- High Availability (HA) mode solves for horizontal scalability and automatic failover within a single region. When in HA mode, Coder continues using a single diff --git a/docs/admin/networking/index.md b/docs/admin/networking/index.md index d2fd31d4b45..4ca43571ccb 100644 --- a/docs/admin/networking/index.md +++ b/docs/admin/networking/index.md @@ -1,4 +1,6 @@ -# Networking +--- +title: Networking +--- Coder's network topology has three types of nodes: workspaces, coder servers, and users. diff --git a/docs/admin/networking/port-forwarding.md b/docs/admin/networking/port-forwarding.md index a20439b1e46..39a4b13b5c7 100644 --- a/docs/admin/networking/port-forwarding.md +++ b/docs/admin/networking/port-forwarding.md @@ -1,4 +1,6 @@ -# Port Forwarding +--- +title: Port Forwarding +--- Port forwarding lets developers securely access processes on their Coder workspace from a local machine. A common use case is testing web applications in diff --git a/docs/admin/networking/stun.md b/docs/admin/networking/stun.md index 13241e2f3e3..c76fe1a31d3 100644 --- a/docs/admin/networking/stun.md +++ b/docs/admin/networking/stun.md @@ -1,4 +1,6 @@ -# STUN and NAT +--- +title: STUN and NAT +--- [Session Traversal Utilities for NAT (STUN)](https://www.rfc-editor.org/rfc/rfc8489.html) is a protocol used to assist applications in establishing peer-to-peer diff --git a/docs/admin/networking/troubleshooting.md b/docs/admin/networking/troubleshooting.md index 15a4959da7d..e3a91810611 100644 --- a/docs/admin/networking/troubleshooting.md +++ b/docs/admin/networking/troubleshooting.md @@ -1,4 +1,6 @@ -# Troubleshooting +--- +title: Troubleshooting +--- `coder ping ` will ping the workspace agent and print diagnostics on the state of the connection. These diagnostics are created by inspecting both diff --git a/docs/admin/security/database-encryption.md b/docs/admin/security/database-encryption.md index 2cbe7ac9be5..e8a9d77b0fb 100644 --- a/docs/admin/security/database-encryption.md +++ b/docs/admin/security/database-encryption.md @@ -1,4 +1,6 @@ -# Database Encryption +--- +title: Database Encryption +--- By default, Coder stores external user tokens and other sensitive values in plaintext in the database. Database Encryption allows Coder administrators to diff --git a/docs/admin/security/index.md b/docs/admin/security/index.md index 02648009a10..4065b756347 100644 --- a/docs/admin/security/index.md +++ b/docs/admin/security/index.md @@ -1,4 +1,6 @@ -# Security +--- +title: Security +--- diff --git a/docs/admin/security/secrets.md b/docs/admin/security/secrets.md index f8276a3ad46..28e69d70ae8 100644 --- a/docs/admin/security/secrets.md +++ b/docs/admin/security/secrets.md @@ -1,4 +1,6 @@ -# Secrets +--- +title: Secrets +--- Coder is open-minded about how you get your secrets into your workspaces. For more information about how to use secrets and other security tips, visit our diff --git a/docs/admin/setup/data-retention.md b/docs/admin/setup/data-retention.md index 661513edade..22fe8f6749a 100644 --- a/docs/admin/setup/data-retention.md +++ b/docs/admin/setup/data-retention.md @@ -1,4 +1,6 @@ -# Data Retention +--- +title: Data Retention +--- Coder supports configurable retention policies that automatically purge old Audit Logs, Connection Logs, Workspace Agent Logs, API keys, and AI Gateway diff --git a/docs/admin/setup/telemetry.md b/docs/admin/setup/telemetry.md index 1f0709c75dd..d8f6aa012cf 100644 --- a/docs/admin/setup/telemetry.md +++ b/docs/admin/setup/telemetry.md @@ -1,4 +1,6 @@ -# Telemetry +--- +title: Telemetry +--- > [!NOTE] > TL;DR: disable telemetry by setting CODER_TELEMETRY_ENABLE=false. diff --git a/docs/admin/templates/creating-templates.md b/docs/admin/templates/creating-templates.md index 9b108557872..ca926c9be72 100644 --- a/docs/admin/templates/creating-templates.md +++ b/docs/admin/templates/creating-templates.md @@ -1,4 +1,6 @@ -# Creating Templates +--- +title: Creating Templates +--- Users with the `Template Administrator` role or above can create templates within Coder. diff --git a/docs/admin/templates/extending-templates/devcontainers.md b/docs/admin/templates/extending-templates/devcontainers.md index 3e775d0eca0..f3f85c26da6 100644 --- a/docs/admin/templates/extending-templates/devcontainers.md +++ b/docs/admin/templates/extending-templates/devcontainers.md @@ -1,4 +1,6 @@ -# Dev Containers +--- +title: Dev Containers +--- Dev containers extend your template with containerized development environments, allowing developers to work in consistent, reproducible setups defined by diff --git a/docs/admin/templates/extending-templates/docker-in-workspaces.md b/docs/admin/templates/extending-templates/docker-in-workspaces.md index 22f7ad709fc..356c34131d1 100644 --- a/docs/admin/templates/extending-templates/docker-in-workspaces.md +++ b/docs/admin/templates/extending-templates/docker-in-workspaces.md @@ -1,4 +1,6 @@ -# Docker in Workspaces +--- +title: Docker in Workspaces +--- There are a few ways to run Docker within container-based Coder workspaces. diff --git a/docs/admin/templates/extending-templates/dynamic-parameters.md b/docs/admin/templates/extending-templates/dynamic-parameters.md index 6d0e47ed999..e791626d516 100644 --- a/docs/admin/templates/extending-templates/dynamic-parameters.md +++ b/docs/admin/templates/extending-templates/dynamic-parameters.md @@ -1,4 +1,6 @@ -# Dynamic Parameters +--- +title: Dynamic Parameters +--- Coder v2.24.0 introduces Dynamic Parameters to extend Coder [parameters](./parameters.md) with conditional form controls, enriched input types, and user identity awareness. diff --git a/docs/admin/templates/extending-templates/icons.md b/docs/admin/templates/extending-templates/icons.md index 57d55d88dc2..6bd083f21a9 100644 --- a/docs/admin/templates/extending-templates/icons.md +++ b/docs/admin/templates/extending-templates/icons.md @@ -1,4 +1,6 @@ -# Icons +--- +title: Icons +--- Coder uses icons in several places, including ones that can be configured throughout the app, or specified in your Terraform. They're specified by a URL, diff --git a/docs/admin/templates/extending-templates/prebuilt-workspaces.md b/docs/admin/templates/extending-templates/prebuilt-workspaces.md index d3aabfaf897..49f6aca9585 100644 --- a/docs/admin/templates/extending-templates/prebuilt-workspaces.md +++ b/docs/admin/templates/extending-templates/prebuilt-workspaces.md @@ -1,4 +1,6 @@ -# Prebuilt workspaces +--- +title: Prebuilt workspaces +--- Prebuilt workspaces (prebuilds) reduce workspace creation time with an automatically-maintained pool of ready-to-use workspaces for specific parameter presets. diff --git a/docs/admin/templates/extending-templates/process-priority.md b/docs/admin/templates/extending-templates/process-priority.md index f4acf6f5d0c..06414fe735e 100644 --- a/docs/admin/templates/extending-templates/process-priority.md +++ b/docs/admin/templates/extending-templates/process-priority.md @@ -1,4 +1,6 @@ -# Improving Agent Resiliency +--- +title: Improving Agent Resiliency +--- Coder's agent can automatically lower the scheduling priority and raise the OOM (out-of-memory) kill score of user processes diff --git a/docs/admin/templates/extending-templates/provider-authentication.md b/docs/admin/templates/extending-templates/provider-authentication.md index 4ddf23fa38f..98171f293fa 100644 --- a/docs/admin/templates/extending-templates/provider-authentication.md +++ b/docs/admin/templates/extending-templates/provider-authentication.md @@ -1,4 +1,6 @@ -# Provider Authentication +--- +title: Provider Authentication +--- > [!CAUTION] > Do not store secrets in templates. Assume every user has cleartext access to every template. diff --git a/docs/admin/templates/extending-templates/resource-metadata.md b/docs/admin/templates/extending-templates/resource-metadata.md index 21f29c10594..6cba901841b 100644 --- a/docs/admin/templates/extending-templates/resource-metadata.md +++ b/docs/admin/templates/extending-templates/resource-metadata.md @@ -1,4 +1,6 @@ -# Resource Metadata +--- +title: Resource Metadata +--- Expose key workspace information to your users with [`coder_metadata`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/metadata) diff --git a/docs/admin/templates/extending-templates/workspace-tags.md b/docs/admin/templates/extending-templates/workspace-tags.md index f2c5ac874cb..19efd1a8953 100644 --- a/docs/admin/templates/extending-templates/workspace-tags.md +++ b/docs/admin/templates/extending-templates/workspace-tags.md @@ -1,4 +1,6 @@ -# Workspace Tags +--- +title: Workspace Tags +--- Template administrators can leverage static template tags to limit workspace provisioning to designated provisioner groups that have locally deployed diff --git a/docs/admin/templates/managing-templates/dependencies.md b/docs/admin/templates/managing-templates/dependencies.md index 5f1338c5b2a..e1eb1697997 100644 --- a/docs/admin/templates/managing-templates/dependencies.md +++ b/docs/admin/templates/managing-templates/dependencies.md @@ -1,4 +1,6 @@ -# Template Dependencies +--- +title: Template Dependencies +--- When creating Coder templates, it is unlikely that you will just be using built-in providers. Part of Terraform's flexibility stems from its rich plugin diff --git a/docs/admin/templates/managing-templates/envbuilder.md b/docs/admin/templates/managing-templates/envbuilder.md index 5de7ee658e3..c74c582aa09 100644 --- a/docs/admin/templates/managing-templates/envbuilder.md +++ b/docs/admin/templates/managing-templates/envbuilder.md @@ -1,4 +1,6 @@ -# Envbuilder +--- +title: Envbuilder +--- Envbuilder shifts environment definition from template administrators to developers. Instead of baking tools into template images, developers define diff --git a/docs/admin/templates/managing-templates/external-workspaces.md b/docs/admin/templates/managing-templates/external-workspaces.md index f958ac0c509..224719ab6d9 100644 --- a/docs/admin/templates/managing-templates/external-workspaces.md +++ b/docs/admin/templates/managing-templates/external-workspaces.md @@ -1,4 +1,6 @@ -# External Workspaces +--- +title: External Workspaces +--- External workspaces allow you to seamlessly connect externally managed infrastructure as Coder workspaces. This enables you to integrate existing servers, on-premises systems, or any capable machine with the Coder environment, ensuring a smooth and efficient development workflow without requiring Coder to provision additional compute resources. diff --git a/docs/admin/templates/managing-templates/image-management.md b/docs/admin/templates/managing-templates/image-management.md index ac7b1e2dcae..80a4a9af75e 100644 --- a/docs/admin/templates/managing-templates/image-management.md +++ b/docs/admin/templates/managing-templates/image-management.md @@ -1,4 +1,6 @@ -# Image Management +--- +title: Image Management +--- While Coder provides example [container images](https://github.com/coder/images) for diff --git a/docs/admin/templates/managing-templates/schedule.md b/docs/admin/templates/managing-templates/schedule.md index b35aa899b79..133181f8588 100644 --- a/docs/admin/templates/managing-templates/schedule.md +++ b/docs/admin/templates/managing-templates/schedule.md @@ -1,4 +1,6 @@ -# Workspace Scheduling +--- +title: Workspace Scheduling +--- You can configure a template to control how workspaces are started and stopped. You can also manage the lifecycle of failed or inactive workspaces. diff --git a/docs/admin/templates/open-in-coder.md b/docs/admin/templates/open-in-coder.md index 3f8bd1cce58..ea6b8fc2d90 100644 --- a/docs/admin/templates/open-in-coder.md +++ b/docs/admin/templates/open-in-coder.md @@ -1,4 +1,6 @@ -# Open in Coder +--- +title: Open in Coder +--- You can embed an "Open in Coder" button into your git repos or internal wikis to let developers quickly launch a new workspace. diff --git a/docs/admin/users/headless-auth.md b/docs/admin/users/headless-auth.md index e61124b7e5b..496a58a9e1d 100644 --- a/docs/admin/users/headless-auth.md +++ b/docs/admin/users/headless-auth.md @@ -1,4 +1,6 @@ -# Headless Authentication +--- +title: Headless Authentication +--- > [!NOTE] > Creating service accounts requires a [Premium license](https://coder.com/pricing). diff --git a/docs/admin/users/idp-sync.md b/docs/admin/users/idp-sync.md index a5fe3da3169..a90de746989 100644 --- a/docs/admin/users/idp-sync.md +++ b/docs/admin/users/idp-sync.md @@ -1,6 +1,8 @@ - -# IdP Sync +--- +title: IdP Sync +--- + > [!NOTE] > IdP sync is a Premium feature. > [Learn more](https://coder.com/pricing#compare-plans). diff --git a/docs/admin/users/index.md b/docs/admin/users/index.md index 32707ab4302..dc65e89ca6e 100644 --- a/docs/admin/users/index.md +++ b/docs/admin/users/index.md @@ -1,4 +1,6 @@ -# Users +--- +title: Users +--- By default, Coder is accessible via password authentication. For production deployments, we recommend using an SSO authentication provider with multi-factor diff --git a/docs/admin/users/oidc-auth/refresh-tokens.md b/docs/admin/users/oidc-auth/refresh-tokens.md index af5e02cb8fa..91ef634364f 100644 --- a/docs/admin/users/oidc-auth/refresh-tokens.md +++ b/docs/admin/users/oidc-auth/refresh-tokens.md @@ -1,4 +1,6 @@ -# Configure OIDC refresh tokens +--- +title: Configure OIDC refresh tokens +--- OIDC refresh tokens allow your Coder deployment to maintain user sessions beyond the initial access token expiration. Without properly configured refresh tokens, users will be automatically logged out when their access token expires. diff --git a/docs/admin/users/password-auth.md b/docs/admin/users/password-auth.md index 7dd9e9e564d..8593bc508ad 100644 --- a/docs/admin/users/password-auth.md +++ b/docs/admin/users/password-auth.md @@ -1,4 +1,6 @@ -# Password Authentication +--- +title: Password Authentication +--- Coder has password authentication enabled by default. The account created during setup is a username/password account. diff --git a/docs/admin/users/quotas.md b/docs/admin/users/quotas.md index d6493689ada..81da46e84a6 100644 --- a/docs/admin/users/quotas.md +++ b/docs/admin/users/quotas.md @@ -1,4 +1,6 @@ -# Quotas +--- +title: Quotas +--- Quotas are a mechanism for controlling spend by associating costs with workspace templates and assigning budgets to users. Users that exceed their budget will be diff --git a/docs/ai-coder/agent-firewall/index.md b/docs/ai-coder/agent-firewall/index.md index 14e50cb342d..46f33edc2d2 100644 --- a/docs/ai-coder/agent-firewall/index.md +++ b/docs/ai-coder/agent-firewall/index.md @@ -1,4 +1,6 @@ -# Agent Firewall +--- +title: Agent Firewall +--- Agent Firewall is a process-level firewall that restricts and audits what autonomous programs, such as AI agents, can access and use. diff --git a/docs/ai-coder/agents/architecture.md b/docs/ai-coder/agents/architecture.md index 021725b3ae4..94165066a35 100644 --- a/docs/ai-coder/agents/architecture.md +++ b/docs/ai-coder/agents/architecture.md @@ -1,4 +1,6 @@ -# Architecture +--- +title: Architecture +--- Coder's AI agent interacts with workspaces over the same connection path as a developer's IDE, web terminal, and SSH session already diff --git a/docs/ai-coder/agents/chat-sharing.md b/docs/ai-coder/agents/chat-sharing.md index 56475a4b488..730af28cce9 100644 --- a/docs/ai-coder/agents/chat-sharing.md +++ b/docs/ai-coder/agents/chat-sharing.md @@ -1,4 +1,6 @@ -# Chat Sharing +--- +title: Chat Sharing +--- Chat sharing lets you give other users or groups read-only access to a Coder Agents conversation. diff --git a/docs/ai-coder/agents/extending-agents.md b/docs/ai-coder/agents/extending-agents.md index 587658b4cc7..b6decad891b 100644 --- a/docs/ai-coder/agents/extending-agents.md +++ b/docs/ai-coder/agents/extending-agents.md @@ -1,4 +1,6 @@ -# Extending Agents +--- +title: Extending Agents +--- Workspace templates can extend the agent with custom skills and MCP tools. These mechanisms let platform teams provide repository-specific instructions, diff --git a/docs/ai-coder/agents/getting-started.md b/docs/ai-coder/agents/getting-started.md index 4579c72819a..15cf2732cda 100644 --- a/docs/ai-coder/agents/getting-started.md +++ b/docs/ai-coder/agents/getting-started.md @@ -1,4 +1,6 @@ -# Getting Started +--- +title: Getting Started +--- This guide walks platform teams and administrators through setting up Coder Agents, preparing your deployment, and running your first Coder Agent. diff --git a/docs/ai-coder/agents/index.md b/docs/ai-coder/agents/index.md index d56ab79c6a4..5cc0bbd545c 100644 --- a/docs/ai-coder/agents/index.md +++ b/docs/ai-coder/agents/index.md @@ -1,4 +1,6 @@ -# Coder Agents +--- +title: Coder Agents +--- Coder Agents is a chat interface and API for delegating development work and research to coding agents in your Coder deployment. Developers describe the work they want done, and Coder Agents handles selecting a template, provisioning a workspace, and executing the task. diff --git a/docs/ai-coder/agents/models.md b/docs/ai-coder/agents/models.md index e707d95737f..31f6ce22a59 100644 --- a/docs/ai-coder/agents/models.md +++ b/docs/ai-coder/agents/models.md @@ -1,4 +1,6 @@ -# Models +--- +title: Models +--- Administrators configure LLM providers from **Admin settings** > **AI** and Coder Agents models from **Admin settings** > **AI** > **Models**. Providers, diff --git a/docs/ai-coder/agents/platform-controls/advisor.md b/docs/ai-coder/agents/platform-controls/advisor.md index 01427f12296..b4b6fba07d4 100644 --- a/docs/ai-coder/agents/platform-controls/advisor.md +++ b/docs/ai-coder/agents/platform-controls/advisor.md @@ -1,4 +1,6 @@ -# Advisor +--- +title: Advisor +--- > [!NOTE] > This feature is experimental. Pin a release before broad rollout and review diff --git a/docs/ai-coder/agents/platform-controls/chat-debug-logging.md b/docs/ai-coder/agents/platform-controls/chat-debug-logging.md index a5389c3ae90..f896f70642b 100644 --- a/docs/ai-coder/agents/platform-controls/chat-debug-logging.md +++ b/docs/ai-coder/agents/platform-controls/chat-debug-logging.md @@ -1,4 +1,6 @@ -# Chat debug logging +--- +title: Chat debug logging +--- Records a detailed trace of each chat turn for troubleshooting: the normalized request sent to the LLM provider, the full response, token usage, diff --git a/docs/ai-coder/agents/platform-controls/git-providers.md b/docs/ai-coder/agents/platform-controls/git-providers.md index df4160d7713..2a4b2038321 100644 --- a/docs/ai-coder/agents/platform-controls/git-providers.md +++ b/docs/ai-coder/agents/platform-controls/git-providers.md @@ -1,4 +1,6 @@ -# Git Providers +--- +title: Git Providers +--- Coder Agents leverages your existing [external authentication](../../../admin/external-auth/index.md) configuration diff --git a/docs/ai-coder/agents/platform-controls/index.md b/docs/ai-coder/agents/platform-controls/index.md index 432050909ef..97ac9dd7551 100644 --- a/docs/ai-coder/agents/platform-controls/index.md +++ b/docs/ai-coder/agents/platform-controls/index.md @@ -1,4 +1,6 @@ -# Platform Controls +--- +title: Platform Controls +--- ## Design philosophy diff --git a/docs/ai-coder/agents/platform-controls/mcp-servers.md b/docs/ai-coder/agents/platform-controls/mcp-servers.md index e957f09d2fc..e4760988cc6 100644 --- a/docs/ai-coder/agents/platform-controls/mcp-servers.md +++ b/docs/ai-coder/agents/platform-controls/mcp-servers.md @@ -1,4 +1,6 @@ -# MCP Servers +--- +title: MCP Servers +--- Administrators can register external MCP servers that provide additional tools for agent chat sessions. Configured servers are injected into or offered to diff --git a/docs/ai-coder/agents/platform-controls/template-optimization.md b/docs/ai-coder/agents/platform-controls/template-optimization.md index c053fa0e651..ea0e8d3a9a6 100644 --- a/docs/ai-coder/agents/platform-controls/template-optimization.md +++ b/docs/ai-coder/agents/platform-controls/template-optimization.md @@ -1,4 +1,6 @@ -# Template Optimization +--- +title: Template Optimization +--- Not every chat with Coder Agents requires a workspace. A workspace is only provisioned when the agent decides it needs compute — to read files, write code, run commands, or diff --git a/docs/ai-coder/agents/platform-controls/virtual-desktop.md b/docs/ai-coder/agents/platform-controls/virtual-desktop.md index bed736d542b..f6697a017a1 100644 --- a/docs/ai-coder/agents/platform-controls/virtual-desktop.md +++ b/docs/ai-coder/agents/platform-controls/virtual-desktop.md @@ -1,4 +1,6 @@ -# Virtual desktop +--- +title: Virtual desktop +--- > [!NOTE] > This feature is experimental. Pin a release before broad rollout and review diff --git a/docs/ai-coder/agents/tools/index.md b/docs/ai-coder/agents/tools/index.md index 111f07946da..57e4c22a596 100644 --- a/docs/ai-coder/agents/tools/index.md +++ b/docs/ai-coder/agents/tools/index.md @@ -1,4 +1,6 @@ -# Tools +--- +title: Tools +--- Coder Agents completes work by calling tools: structured functions the agent invokes during a chat to gather context and take action, such as listing diff --git a/docs/ai-coder/ai-gateway/ai-gateway-proxy/index.md b/docs/ai-coder/ai-gateway/ai-gateway-proxy/index.md index 9b10bcf9272..d14f6f044ab 100644 --- a/docs/ai-coder/ai-gateway/ai-gateway-proxy/index.md +++ b/docs/ai-coder/ai-gateway/ai-gateway-proxy/index.md @@ -1,4 +1,6 @@ -# AI Gateway Proxy +--- +title: AI Gateway Proxy +--- > [!NOTE] > AI Gateway Proxy is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/ai-gateway-proxy/setup.md b/docs/ai-coder/ai-gateway/ai-gateway-proxy/setup.md index 0fd17985c55..38d73b1acf3 100644 --- a/docs/ai-coder/ai-gateway/ai-gateway-proxy/setup.md +++ b/docs/ai-coder/ai-gateway/ai-gateway-proxy/setup.md @@ -1,4 +1,6 @@ -# Setup +--- +title: Setup +--- AI Gateway Proxy runs inside the Coder control plane (`coderd`), requiring no separate compute to deploy or scale. Once enabled, `coderd` runs the AI Gateway Proxy in-process and intercepts traffic to supported AI providers, forwarding it to AI Gateway. diff --git a/docs/ai-coder/ai-gateway/audit.md b/docs/ai-coder/ai-gateway/audit.md index b43f8984413..7a0515c9a2e 100644 --- a/docs/ai-coder/ai-gateway/audit.md +++ b/docs/ai-coder/ai-gateway/audit.md @@ -1,4 +1,6 @@ -# Auditing AI Sessions +--- +title: Auditing AI Sessions +--- > [!NOTE] > AI Gateway is part of [AI Governance](../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/auth.md b/docs/ai-coder/ai-gateway/auth.md index 1cab40e8aab..1515d44456c 100644 --- a/docs/ai-coder/ai-gateway/auth.md +++ b/docs/ai-coder/ai-gateway/auth.md @@ -1,4 +1,6 @@ -# Authentication +--- +title: Authentication +--- > [!NOTE] > AI Gateway is part of [AI Governance](../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/clients/claude-code.md b/docs/ai-coder/ai-gateway/clients/claude-code.md index 1c68f382e19..15e99d740bf 100644 --- a/docs/ai-coder/ai-gateway/clients/claude-code.md +++ b/docs/ai-coder/ai-gateway/clients/claude-code.md @@ -1,4 +1,6 @@ -# Claude Code +--- +title: Claude Code +--- > [!NOTE] > AI Gateway is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/clients/cline.md b/docs/ai-coder/ai-gateway/clients/cline.md index 6b1bdfbca1a..4772ad30c56 100644 --- a/docs/ai-coder/ai-gateway/clients/cline.md +++ b/docs/ai-coder/ai-gateway/clients/cline.md @@ -1,4 +1,6 @@ -# Cline +--- +title: Cline +--- > [!NOTE] > AI Gateway is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/clients/copilot.md b/docs/ai-coder/ai-gateway/clients/copilot.md index 27304fb5ab4..0bc6eda70ce 100644 --- a/docs/ai-coder/ai-gateway/clients/copilot.md +++ b/docs/ai-coder/ai-gateway/clients/copilot.md @@ -1,4 +1,6 @@ -# GitHub Copilot +--- +title: GitHub Copilot +--- > [!NOTE] > AI Gateway is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/clients/factory.md b/docs/ai-coder/ai-gateway/clients/factory.md index c70b260ad72..d2f1a4d6025 100644 --- a/docs/ai-coder/ai-gateway/clients/factory.md +++ b/docs/ai-coder/ai-gateway/clients/factory.md @@ -1,4 +1,6 @@ -# Factory +--- +title: Factory +--- > [!NOTE] > AI Gateway is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/clients/index.md b/docs/ai-coder/ai-gateway/clients/index.md index 481aaf1884d..57b32585363 100644 --- a/docs/ai-coder/ai-gateway/clients/index.md +++ b/docs/ai-coder/ai-gateway/clients/index.md @@ -1,4 +1,6 @@ -# Client Configuration +--- +title: Client Configuration +--- > [!NOTE] > AI Gateway is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/clients/kilo-code.md b/docs/ai-coder/ai-gateway/clients/kilo-code.md index 6922a90f4c1..3787a43404c 100644 --- a/docs/ai-coder/ai-gateway/clients/kilo-code.md +++ b/docs/ai-coder/ai-gateway/clients/kilo-code.md @@ -1,4 +1,6 @@ -# Kilo Code +--- +title: Kilo Code +--- > [!NOTE] > AI Gateway is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/clients/mux.md b/docs/ai-coder/ai-gateway/clients/mux.md index 4756e4b5c4f..50c02207bf3 100644 --- a/docs/ai-coder/ai-gateway/clients/mux.md +++ b/docs/ai-coder/ai-gateway/clients/mux.md @@ -1,4 +1,6 @@ -# Mux +--- +title: Mux +--- > [!NOTE] > AI Gateway is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/clients/opencode.md b/docs/ai-coder/ai-gateway/clients/opencode.md index 388174138e2..bbe82f54ae0 100644 --- a/docs/ai-coder/ai-gateway/clients/opencode.md +++ b/docs/ai-coder/ai-gateway/clients/opencode.md @@ -1,4 +1,6 @@ -# OpenCode +--- +title: OpenCode +--- > [!NOTE] > AI Gateway is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/clients/vscode.md b/docs/ai-coder/ai-gateway/clients/vscode.md index 558c03df58b..77f300a9708 100644 --- a/docs/ai-coder/ai-gateway/clients/vscode.md +++ b/docs/ai-coder/ai-gateway/clients/vscode.md @@ -1,3 +1,6 @@ +--- +title: VS Code +--- > [!NOTE] > AI Gateway is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/clients/zed.md b/docs/ai-coder/ai-gateway/clients/zed.md index 51eed6612dd..1f09b878af9 100644 --- a/docs/ai-coder/ai-gateway/clients/zed.md +++ b/docs/ai-coder/ai-gateway/clients/zed.md @@ -1,4 +1,6 @@ -# Zed +--- +title: Zed +--- > [!NOTE] > AI Gateway is part of [AI Governance](../../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/cost-controls.md b/docs/ai-coder/ai-gateway/cost-controls.md index 52c4fa13c44..d27fdd15b2a 100644 --- a/docs/ai-coder/ai-gateway/cost-controls.md +++ b/docs/ai-coder/ai-gateway/cost-controls.md @@ -1,4 +1,6 @@ -# AI Governance Cost Control +--- +title: AI Governance Cost Control +--- > [!NOTE] > AI Gateway is part of [AI Governance](../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/index.md b/docs/ai-coder/ai-gateway/index.md index e252b9becbd..257bdcc2b37 100644 --- a/docs/ai-coder/ai-gateway/index.md +++ b/docs/ai-coder/ai-gateway/index.md @@ -1,4 +1,6 @@ -# AI Gateway +--- +title: AI Gateway +--- ![AI Gateway diagram](../../images/aibridge/aibridge_diagram.png) diff --git a/docs/ai-coder/ai-gateway/monitoring.md b/docs/ai-coder/ai-gateway/monitoring.md index da45b643ee0..f37a4ad3c6a 100644 --- a/docs/ai-coder/ai-gateway/monitoring.md +++ b/docs/ai-coder/ai-gateway/monitoring.md @@ -1,4 +1,6 @@ -# Monitoring +--- +title: Monitoring +--- > [!NOTE] > AI Gateway is part of [AI Governance](../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/providers.md b/docs/ai-coder/ai-gateway/providers.md index 8e2535879d3..e520778c403 100644 --- a/docs/ai-coder/ai-gateway/providers.md +++ b/docs/ai-coder/ai-gateway/providers.md @@ -1,4 +1,6 @@ -# Provider Configuration +--- +title: Provider Configuration +--- > [!NOTE] > AI Gateway is part of [AI Governance](../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/rebranding-migration.md b/docs/ai-coder/ai-gateway/rebranding-migration.md index 2103d025c9c..e80ffbd5fa0 100644 --- a/docs/ai-coder/ai-gateway/rebranding-migration.md +++ b/docs/ai-coder/ai-gateway/rebranding-migration.md @@ -1,4 +1,6 @@ -# Rebranding Migration +--- +title: Rebranding Migration +--- AI Bridge has been renamed to **AI Gateway**. This is a cosmetic rebrand to make the feature easier to understand. It changes user-visible names, configuration diff --git a/docs/ai-coder/ai-gateway/reference.md b/docs/ai-coder/ai-gateway/reference.md index 68836e01ec6..e3be4a4f13b 100644 --- a/docs/ai-coder/ai-gateway/reference.md +++ b/docs/ai-coder/ai-gateway/reference.md @@ -1,4 +1,6 @@ -# Reference +--- +title: Reference +--- > [!NOTE] > AI Gateway is part of [AI Governance](../ai-governance.md), which is diff --git a/docs/ai-coder/ai-gateway/setup.md b/docs/ai-coder/ai-gateway/setup.md index 91f48c120ed..2b0e0f7e65b 100644 --- a/docs/ai-coder/ai-gateway/setup.md +++ b/docs/ai-coder/ai-gateway/setup.md @@ -1,4 +1,6 @@ -# Setup +--- +title: Setup +--- By default, AI Gateway runs inside the Coder control plane (`coderd`) and requires no separate compute. In embedded mode, `coderd` runs the Gateway in memory and brokers traffic to your configured AI providers on behalf of authenticated users. diff --git a/docs/ai-coder/ai-governance.md b/docs/ai-coder/ai-governance.md index 5a954fc8b46..15579d86338 100644 --- a/docs/ai-coder/ai-governance.md +++ b/docs/ai-coder/ai-governance.md @@ -1,4 +1,6 @@ -# AI Governance +--- +title: AI Governance +--- Coder Workspaces already lets teams run AI tools like [Cursor](https://registry.coder.com/modules/coder/cursor) and diff --git a/docs/ai-coder/best-practices.md b/docs/ai-coder/best-practices.md index 5208c9c342a..1f6f050bc85 100644 --- a/docs/ai-coder/best-practices.md +++ b/docs/ai-coder/best-practices.md @@ -1,4 +1,6 @@ -# Best Practices +--- +title: Best Practices +--- This document includes a mix of cultural and technical best practices and guidelines for introducing AI agents into your organization. diff --git a/docs/ai-coder/custom-agents.md b/docs/ai-coder/custom-agents.md index 5145ed203b1..316aa4d45ee 100644 --- a/docs/ai-coder/custom-agents.md +++ b/docs/ai-coder/custom-agents.md @@ -1,4 +1,6 @@ -# Custom Agents +--- +title: Custom Agents +--- > [!WARNING] > Starting June 2, 2026, Coder Tasks will move to a 12-month Extended Support Release (ESR) for Premium customers. diff --git a/docs/ai-coder/ide-agents.md b/docs/ai-coder/ide-agents.md index a6e960f28ee..7982a233996 100644 --- a/docs/ai-coder/ide-agents.md +++ b/docs/ai-coder/ide-agents.md @@ -1,3 +1,7 @@ +--- +title: In the IDE +--- + Learn how to use Coder Workspaces with IDEs and plugins to run coding agents like Cursor, GitHub Copilot, Windsurf, RooCode, and more. ## How it works diff --git a/docs/ai-coder/index.md b/docs/ai-coder/index.md index c9f8dc0aeb1..15ffefced21 100644 --- a/docs/ai-coder/index.md +++ b/docs/ai-coder/index.md @@ -1,4 +1,6 @@ -# Run AI Coding Agents in Coder +--- +title: Run AI Coding Agents in Coder +--- Learn how to run & manage coding agents with Coder, both alongside existing workspaces and for background task execution. diff --git a/docs/ai-coder/mcp-server.md b/docs/ai-coder/mcp-server.md index 8b0b9194bee..9c02a34fc48 100644 --- a/docs/ai-coder/mcp-server.md +++ b/docs/ai-coder/mcp-server.md @@ -1,4 +1,6 @@ -# MCP Server +--- +title: MCP Server +--- Coder includes a built-in [Model Context Protocol](https://modelcontextprotocol.io/) (MCP) server that provides AI assistants with tools and context about your Coder diff --git a/docs/ai-coder/security.md b/docs/ai-coder/security.md index af832c3a5ac..0da6eca69e0 100644 --- a/docs/ai-coder/security.md +++ b/docs/ai-coder/security.md @@ -1,3 +1,7 @@ +--- +title: Security & Agent Firewall +--- + > [!NOTE] > Features mentioned on this page, such as AI Gateway and Agent Firewall, > are part of [AI Governance](./ai-governance.md), which is included with a diff --git a/docs/ai-coder/tasks-core-principles.md b/docs/ai-coder/tasks-core-principles.md index 404799cf05d..8e1457cf831 100644 --- a/docs/ai-coder/tasks-core-principles.md +++ b/docs/ai-coder/tasks-core-principles.md @@ -1,4 +1,6 @@ -# Understanding Coder Tasks +--- +title: Understanding Coder Tasks +--- > [!WARNING] > Starting June 2, 2026, Coder Tasks will move to a 12-month Extended Support Release (ESR) for Premium customers. diff --git a/docs/ai-coder/tasks.md b/docs/ai-coder/tasks.md index ccec810e64d..1950965d1a2 100644 --- a/docs/ai-coder/tasks.md +++ b/docs/ai-coder/tasks.md @@ -1,4 +1,6 @@ -# Coder Tasks +--- +title: Coder Tasks +--- > [!WARNING] > Starting June 2, 2026, Coder Tasks will move to a 12-month Extended Support Release (ESR) for Premium customers. diff --git a/docs/ai-coder/usage-data-reporting.md b/docs/ai-coder/usage-data-reporting.md index 3c69e27ae0b..2c86ddafdca 100644 --- a/docs/ai-coder/usage-data-reporting.md +++ b/docs/ai-coder/usage-data-reporting.md @@ -1,4 +1,6 @@ -# Usage Data Reporting +--- +title: Usage Data Reporting +--- [AI Governance](./ai-governance.md) requires reporting usage data to Tallyman, a Coder-managed server for billing and reporting purposes. Coder only captures and sends the following information, related to your deployment ID: diff --git a/docs/get-started/customize-your-template/authenticate-to-github.md b/docs/get-started/customize-your-template/authenticate-to-github.md index aa0e811985b..fc88b1c186f 100644 --- a/docs/get-started/customize-your-template/authenticate-to-github.md +++ b/docs/get-started/customize-your-template/authenticate-to-github.md @@ -1,4 +1,6 @@ -# Clone private repositories +--- +title: Clone private repositories +--- Now that you've finished [Launch your first workspace](../index.md), you can let your workspaces clone private GitHub repositories without a manual login each time. diff --git a/docs/get-started/customize-your-template/index.md b/docs/get-started/customize-your-template/index.md index 398e76c6338..adef3cd43f5 100644 --- a/docs/get-started/customize-your-template/index.md +++ b/docs/get-started/customize-your-template/index.md @@ -1,4 +1,6 @@ -# Customize your template +--- +title: Customize your template +--- In [Launch your first workspace](../index.md), you installed the `coder` CLI, started the Coder server, and built a workspace from the Quickstart template. That template is a good starting point, but it has gaps: diff --git a/docs/get-started/customize-your-template/install-command-line-tools.md b/docs/get-started/customize-your-template/install-command-line-tools.md index 449756527d2..2c411b83d2f 100644 --- a/docs/get-started/customize-your-template/install-command-line-tools.md +++ b/docs/get-started/customize-your-template/install-command-line-tools.md @@ -1,4 +1,6 @@ -# Install your own command-line tools +--- +title: Install your own command-line tools +--- Now that you [launched your first workspace](../index.md), you can add your favorite command-line tools to every workspace. diff --git a/docs/install/airgap.md b/docs/install/airgap.md index 06e99571c37..0eeeb078068 100644 --- a/docs/install/airgap.md +++ b/docs/install/airgap.md @@ -1,4 +1,6 @@ -# Air-gapped Deployments +--- +title: Air-gapped Deployments +--- All Coder features are supported in air-gapped / behind firewalls / disconnected / offline. This is a general comparison. Keep reading for a full tutorial running Coder diff --git a/docs/install/kubernetes/kubernetes-azure-app-gateway.md b/docs/install/kubernetes/kubernetes-azure-app-gateway.md index 6a3236ed5a3..4090a1f1634 100644 --- a/docs/install/kubernetes/kubernetes-azure-app-gateway.md +++ b/docs/install/kubernetes/kubernetes-azure-app-gateway.md @@ -1,4 +1,6 @@ -# Deploy Coder on Azure with an Application Gateway +--- +title: Deploy Coder on Azure with an Application Gateway +--- In certain enterprise environments, the [Azure Application Gateway](https://learn.microsoft.com/en-us/azure/application-gateway/ingress-controller-overview) is required. diff --git a/docs/install/openshift.md b/docs/install/openshift.md index 1216c41ecb3..84df8318325 100644 --- a/docs/install/openshift.md +++ b/docs/install/openshift.md @@ -1,4 +1,6 @@ -# OpenShift +--- +title: OpenShift +--- ## Requirements diff --git a/docs/install/releases/esr-2.24-2.29-upgrade.md b/docs/install/releases/esr-2.24-2.29-upgrade.md index 1789477f54d..b1492f66efe 100644 --- a/docs/install/releases/esr-2.24-2.29-upgrade.md +++ b/docs/install/releases/esr-2.24-2.29-upgrade.md @@ -1,4 +1,6 @@ -# Upgrading from ESR 2.24 to 2.29 +--- +title: Upgrading from ESR 2.24 to 2.29 +--- ## Guide Overview diff --git a/docs/install/releases/esr-2.29-2.34-upgrade.md b/docs/install/releases/esr-2.29-2.34-upgrade.md index 4b430e36347..edf4f7adadc 100644 --- a/docs/install/releases/esr-2.29-2.34-upgrade.md +++ b/docs/install/releases/esr-2.29-2.34-upgrade.md @@ -1,4 +1,6 @@ -# Upgrading from ESR 2.29 to 2.34 +--- +title: Upgrading from ESR 2.29 to 2.34 +--- ## Guide Overview diff --git a/docs/install/releases/feature-stages.md b/docs/install/releases/feature-stages.md index 57ccea3121d..52de8da360f 100644 --- a/docs/install/releases/feature-stages.md +++ b/docs/install/releases/feature-stages.md @@ -1,4 +1,6 @@ -# Feature stages +--- +title: Feature stages +--- Some Coder features are released in feature stages before they are generally available. diff --git a/docs/install/releases/index.md b/docs/install/releases/index.md index e3d41a67f63..5483cb42df5 100644 --- a/docs/install/releases/index.md +++ b/docs/install/releases/index.md @@ -1,4 +1,6 @@ -# Releases +--- +title: Releases +--- Coder releases are cut directly from main in our [GitHub](https://github.com/coder/coder) on the first Tuesday of each month. diff --git a/docs/install/uninstall.md b/docs/install/uninstall.md index c2df3d65303..00127158c9a 100644 --- a/docs/install/uninstall.md +++ b/docs/install/uninstall.md @@ -1,6 +1,8 @@ - -# Uninstall +--- +title: Uninstall +--- + This article walks you through how to uninstall your Coder server. To uninstall your Coder server, delete the following directories. diff --git a/docs/install/upgrade-best-practices.md b/docs/install/upgrade-best-practices.md index 1c4c8a777ba..98af7c92b54 100644 --- a/docs/install/upgrade-best-practices.md +++ b/docs/install/upgrade-best-practices.md @@ -1,4 +1,6 @@ -# Upgrading Best Practices +--- +title: Upgrading Best Practices +--- This guide provides best practices for upgrading Coder, along with troubleshooting steps for common issues encountered during upgrades, diff --git a/docs/reference/agent-api/debug.md b/docs/reference/agent-api/debug.md index ca3e5c5e1cd..a3fcfb7363e 100644 --- a/docs/reference/agent-api/debug.md +++ b/docs/reference/agent-api/debug.md @@ -1,4 +1,6 @@ -# Debug +--- +title: Debug +--- ## Get debug logs diff --git a/docs/reference/agent-api/schemas.md b/docs/reference/agent-api/schemas.md index a806529b098..d275e572942 100644 --- a/docs/reference/agent-api/schemas.md +++ b/docs/reference/agent-api/schemas.md @@ -1,4 +1,6 @@ -# Schemas +--- +title: Schemas +--- ## agentsdk.Manifest diff --git a/docs/reference/glossary.md b/docs/reference/glossary.md index 6f0320c551f..24a8bb891fe 100644 --- a/docs/reference/glossary.md +++ b/docs/reference/glossary.md @@ -1,4 +1,6 @@ -# Glossary +--- +title: Glossary +--- This glossary defines the Coder-specific terms and product names you encounter across the documentation. Each entry gives a short definition and, where it helps, links to the page that covers the term in depth. diff --git a/docs/reference/index.md b/docs/reference/index.md index 4e7c5d9134f..2512eac13c0 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -1,4 +1,6 @@ -# Reference +--- +title: Reference +--- ## Automation diff --git a/docs/support/index.md b/docs/support/index.md index 28787b364f3..5674ccaace7 100644 --- a/docs/support/index.md +++ b/docs/support/index.md @@ -1,4 +1,6 @@ -# Support +--- +title: Support +--- If you have questions, encounter an issue or bug, or if you have a feature request, [open a GitHub issue](https://github.com/coder/coder/issues/new) or [join our Discord](https://discord.gg/coder). diff --git a/docs/tutorials/best-practices/index.md b/docs/tutorials/best-practices/index.md index ccc12f61e5a..2c346da4d0a 100644 --- a/docs/tutorials/best-practices/index.md +++ b/docs/tutorials/best-practices/index.md @@ -1,4 +1,6 @@ -# Best practices +--- +title: Best practices +--- Guides to help you make the most of your Coder experience. diff --git a/docs/tutorials/best-practices/organizations.md b/docs/tutorials/best-practices/organizations.md index 14a42a5e820..1bdee102d28 100644 --- a/docs/tutorials/best-practices/organizations.md +++ b/docs/tutorials/best-practices/organizations.md @@ -1,4 +1,6 @@ -# Organizations - best practices +--- +title: Organizations - best practices +--- --- diff --git a/docs/tutorials/best-practices/security-best-practices.md b/docs/tutorials/best-practices/security-best-practices.md index 55edf1ddb21..8afb9bd3359 100644 --- a/docs/tutorials/best-practices/security-best-practices.md +++ b/docs/tutorials/best-practices/security-best-practices.md @@ -1,4 +1,6 @@ -# Security - best practices +--- +title: Security - best practices +--- December 16, 2024 diff --git a/docs/tutorials/cloning-git-repositories.md b/docs/tutorials/cloning-git-repositories.md index b166ef8dd15..2b0bf3c335e 100644 --- a/docs/tutorials/cloning-git-repositories.md +++ b/docs/tutorials/cloning-git-repositories.md @@ -1,4 +1,6 @@ -# Cloning Git Repositories +--- +title: Cloning Git Repositories +---
Author: diff --git a/docs/tutorials/faqs.md b/docs/tutorials/faqs.md index 0bbbd629fe3..f2f0ab61b3d 100644 --- a/docs/tutorials/faqs.md +++ b/docs/tutorials/faqs.md @@ -1,4 +1,6 @@ -# FAQs +--- +title: FAQs +--- Frequently asked questions on Coder OSS and licensed deployments. These FAQs come from our community and customers, feel free to diff --git a/docs/user-guides/desktop/desktop-connect-sync.md b/docs/user-guides/desktop/desktop-connect-sync.md index 00eccf89a9e..1b96f8dce3f 100644 --- a/docs/user-guides/desktop/desktop-connect-sync.md +++ b/docs/user-guides/desktop/desktop-connect-sync.md @@ -1,4 +1,6 @@ -# Coder Desktop Connect and Sync +--- +title: Coder Desktop Connect and Sync +--- Use Coder Desktop to work on your workspaces and files as though they're on your LAN. diff --git a/docs/user-guides/desktop/index.md b/docs/user-guides/desktop/index.md index 7f4616918e8..d7410bc9bf6 100644 --- a/docs/user-guides/desktop/index.md +++ b/docs/user-guides/desktop/index.md @@ -1,4 +1,6 @@ -# Coder Desktop +--- +title: Coder Desktop +--- Coder Desktop provides seamless access to your remote workspaces through a native application. Connect to workspace services using simple hostnames like `myworkspace.coder`, launch applications with one click, and synchronize files between local and remote environments, all without installing a CLI or configuring manual port forwarding. diff --git a/docs/user-guides/devcontainers/customizing-dev-containers.md b/docs/user-guides/devcontainers/customizing-dev-containers.md index b5010d29ad9..7ae8c4b0745 100644 --- a/docs/user-guides/devcontainers/customizing-dev-containers.md +++ b/docs/user-guides/devcontainers/customizing-dev-containers.md @@ -1,4 +1,6 @@ -# Customizing dev containers +--- +title: Customizing dev containers +--- Coder supports custom configuration in your `devcontainer.json` file through the `customizations.coder` block. These options let you control how Coder interacts diff --git a/docs/user-guides/devcontainers/index.md b/docs/user-guides/devcontainers/index.md index b96e6aa641a..d782210724d 100644 --- a/docs/user-guides/devcontainers/index.md +++ b/docs/user-guides/devcontainers/index.md @@ -1,4 +1,6 @@ -# Dev Containers +--- +title: Dev Containers +--- [Dev containers](https://containers.dev/) define your development environment as code using a `devcontainer.json` file. Coder's Dev Containers integration diff --git a/docs/user-guides/devcontainers/troubleshooting-dev-containers.md b/docs/user-guides/devcontainers/troubleshooting-dev-containers.md index c5acb79b2c6..c0ae54dd32a 100644 --- a/docs/user-guides/devcontainers/troubleshooting-dev-containers.md +++ b/docs/user-guides/devcontainers/troubleshooting-dev-containers.md @@ -1,4 +1,6 @@ -# Troubleshooting dev containers +--- +title: Troubleshooting dev containers +--- ## Dev container not starting diff --git a/docs/user-guides/index.md b/docs/user-guides/index.md index ab636eaf776..a9a418ec571 100644 --- a/docs/user-guides/index.md +++ b/docs/user-guides/index.md @@ -1,4 +1,6 @@ -# User Guides +--- +title: User Guides +--- These guides contain information on workspace management, workspace access via IDEs, environment personalization, and workspace scheduling. diff --git a/docs/user-guides/user-secrets.md b/docs/user-guides/user-secrets.md index df9494f6668..4ae6549d6d7 100644 --- a/docs/user-guides/user-secrets.md +++ b/docs/user-guides/user-secrets.md @@ -1,4 +1,6 @@ -# User secrets +--- +title: User secrets +--- User secrets let you store secret values in Coder and make them available in every workspace you own. diff --git a/docs/user-guides/workspace-access/antigravity.md b/docs/user-guides/workspace-access/antigravity.md index d7cf1ec2888..540ca1cec21 100644 --- a/docs/user-guides/workspace-access/antigravity.md +++ b/docs/user-guides/workspace-access/antigravity.md @@ -1,4 +1,6 @@ -# Antigravity +--- +title: Antigravity +--- [Antigravity](https://antigravity.google/) is Google's desktop IDE. diff --git a/docs/user-guides/workspace-access/code-server.md b/docs/user-guides/workspace-access/code-server.md index baa36b010c0..e1341d90080 100644 --- a/docs/user-guides/workspace-access/code-server.md +++ b/docs/user-guides/workspace-access/code-server.md @@ -1,4 +1,6 @@ -# code-server +--- +title: code-server +--- [code-server](https://github.com/coder/code-server) is our supported method of running VS Code in the web browser. diff --git a/docs/user-guides/workspace-access/cursor.md b/docs/user-guides/workspace-access/cursor.md index daebb4d5657..2dce4d40e6c 100644 --- a/docs/user-guides/workspace-access/cursor.md +++ b/docs/user-guides/workspace-access/cursor.md @@ -1,4 +1,6 @@ -# Cursor +--- +title: Cursor +--- [Cursor](https://cursor.sh/) is a modern IDE built on top of VS Code with enhanced AI capabilities. diff --git a/docs/user-guides/workspace-access/emacs-tramp.md b/docs/user-guides/workspace-access/emacs-tramp.md index 79b9e59de81..80d3b5c0130 100644 --- a/docs/user-guides/workspace-access/emacs-tramp.md +++ b/docs/user-guides/workspace-access/emacs-tramp.md @@ -1,4 +1,6 @@ -# Emacs TRAMP +--- +title: Emacs TRAMP +--- [Emacs TRAMP](https://www.emacswiki.org/emacs/TrampMode) is a method of running editing operations on a remote server. diff --git a/docs/user-guides/workspace-access/jetbrains/fleet.md b/docs/user-guides/workspace-access/jetbrains/fleet.md index bba9bf762d6..9daf44c5922 100644 --- a/docs/user-guides/workspace-access/jetbrains/fleet.md +++ b/docs/user-guides/workspace-access/jetbrains/fleet.md @@ -1,4 +1,6 @@ -# JetBrains Fleet +--- +title: JetBrains Fleet +--- JetBrains Fleet is a code editor and lightweight IDE designed to support various programming languages and development environments. diff --git a/docs/user-guides/workspace-access/jetbrains/gateway.md b/docs/user-guides/workspace-access/jetbrains/gateway.md index 918f6f54df9..b970ec9cfea 100644 --- a/docs/user-guides/workspace-access/jetbrains/gateway.md +++ b/docs/user-guides/workspace-access/jetbrains/gateway.md @@ -1,3 +1,7 @@ +--- +title: JetBrains Gateway +--- + ## JetBrains Gateway > [! WARNING] diff --git a/docs/user-guides/workspace-access/jetbrains/index.md b/docs/user-guides/workspace-access/jetbrains/index.md index 8189d1333ad..2304f608d7f 100644 --- a/docs/user-guides/workspace-access/jetbrains/index.md +++ b/docs/user-guides/workspace-access/jetbrains/index.md @@ -1,4 +1,6 @@ -# JetBrains IDEs +--- +title: JetBrains IDEs +--- Coder supports JetBrains IDEs using [Toolbox](https://www.jetbrains.com/toolbox/) and [Gateway](https://www.jetbrains.com/remote-development/gateway/). The following IDEs are supported for remote development: diff --git a/docs/user-guides/workspace-access/vscode.md b/docs/user-guides/workspace-access/vscode.md index b98a919fff1..3c2cc5e0ecc 100644 --- a/docs/user-guides/workspace-access/vscode.md +++ b/docs/user-guides/workspace-access/vscode.md @@ -1,4 +1,6 @@ -# Visual Studio Code +--- +title: Visual Studio Code +--- You can develop in your Coder workspace remotely with [VS Code](https://code.visualstudio.com/download). diff --git a/docs/user-guides/workspace-access/web-terminal.md b/docs/user-guides/workspace-access/web-terminal.md index 32d75647a62..19bf01876f5 100644 --- a/docs/user-guides/workspace-access/web-terminal.md +++ b/docs/user-guides/workspace-access/web-terminal.md @@ -1,4 +1,6 @@ -# Web Terminal +--- +title: Web Terminal +--- The Web Terminal is a browser-based terminal interface that provides instant access to your workspace's shell environment directly from the Coder dashboard. diff --git a/docs/user-guides/workspace-access/windsurf.md b/docs/user-guides/workspace-access/windsurf.md index 1edd656fc1b..68f71a66dce 100644 --- a/docs/user-guides/workspace-access/windsurf.md +++ b/docs/user-guides/workspace-access/windsurf.md @@ -1,4 +1,6 @@ -# Windsurf +--- +title: Windsurf +--- [Windsurf](https://codeium.com/windsurf) is Codeium's code editor designed for AI-assisted development. diff --git a/docs/user-guides/workspace-access/zed.md b/docs/user-guides/workspace-access/zed.md index 635915d9a4e..bd95406a74e 100644 --- a/docs/user-guides/workspace-access/zed.md +++ b/docs/user-guides/workspace-access/zed.md @@ -1,4 +1,6 @@ -# Zed +--- +title: Zed +--- [Zed](https://zed.dev/) is an [open-source](https://github.com/zed-industries/zed) multiplayer code editor from the creators of Atom and Tree-sitter. diff --git a/docs/user-guides/workspace-dotfiles.md b/docs/user-guides/workspace-dotfiles.md index b23ce318814..288fe6ef651 100644 --- a/docs/user-guides/workspace-dotfiles.md +++ b/docs/user-guides/workspace-dotfiles.md @@ -1,4 +1,6 @@ -# Dotfiles +--- +title: Dotfiles +--- From 7cdc8be81f86f54e497b5863a3c4de21df48240b Mon Sep 17 00:00:00 2001 From: Nick Vigilante Date: Tue, 11 Aug 2026 19:33:03 +0000 Subject: [PATCH 2/2] docs: exclude generated pages from front-matter batch prometheus.md, platform-controls/index.md, and feature-stages.md are make gen outputs whose generators do not yet emit front matter, so a hand-added title would be reverted on the next generation. Excluded here and tracked separately (update the generators, Phase 2 pattern). --- docs/admin/integrations/prometheus.md | 4 +--- docs/ai-coder/agents/platform-controls/index.md | 4 +--- docs/install/releases/feature-stages.md | 4 +--- 3 files changed, 3 insertions(+), 9 deletions(-) diff --git a/docs/admin/integrations/prometheus.md b/docs/admin/integrations/prometheus.md index fabae1043b3..2d418b34a0b 100644 --- a/docs/admin/integrations/prometheus.md +++ b/docs/admin/integrations/prometheus.md @@ -1,6 +1,4 @@ ---- -title: Prometheus ---- +# Prometheus Coder exposes many metrics which can be consumed by a Prometheus server, and give insight into the current state of a live Coder deployment. diff --git a/docs/ai-coder/agents/platform-controls/index.md b/docs/ai-coder/agents/platform-controls/index.md index 97ac9dd7551..432050909ef 100644 --- a/docs/ai-coder/agents/platform-controls/index.md +++ b/docs/ai-coder/agents/platform-controls/index.md @@ -1,6 +1,4 @@ ---- -title: Platform Controls ---- +# Platform Controls ## Design philosophy diff --git a/docs/install/releases/feature-stages.md b/docs/install/releases/feature-stages.md index 52de8da360f..57ccea3121d 100644 --- a/docs/install/releases/feature-stages.md +++ b/docs/install/releases/feature-stages.md @@ -1,6 +1,4 @@ ---- -title: Feature stages ---- +# Feature stages Some Coder features are released in feature stages before they are generally available.