From ac2c1616366e4124ecdf6afa712068e27cb57379 Mon Sep 17 00:00:00 2001 From: Andrew Aquino Date: Wed, 12 Nov 2025 11:11:51 -0800 Subject: [PATCH] fix(docs): add newlines to display GFM alerts correctly (#20747) Fixes this bug called out by @matifali on https://coder.com/docs/ai-coder/tasks: image [The docs for GFM alerts](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) specify that the alert type (`[!NOTE]`, `[!IMPORTANT]`, etc) should be on its own line within the blockquote, with the alert text on the following line(s). --- docs/ai-coder/tasks-core-principles.md | 3 ++- docs/ai-coder/tasks-migration.md | 3 ++- docs/ai-coder/tasks.md | 6 ++++-- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/ai-coder/tasks-core-principles.md b/docs/ai-coder/tasks-core-principles.md index 66053d486d..fadd4273b0 100644 --- a/docs/ai-coder/tasks-core-principles.md +++ b/docs/ai-coder/tasks-core-principles.md @@ -56,7 +56,8 @@ Coder maintains various agentic modules; see [Coder Labs](https://registry.coder The following code snippet can be dropped into any existing template in Coder v2.28 or above to modify it into a Claude-Code enabled task template. This snippet also includes space for a setup script that will prime the agent for execution. -> [!NOTE] This requires at least version 2.13.0 of the `coder/coder` Terraform provider. +> [!NOTE] +> This requires at least version 2.13.0 of the `coder/coder` Terraform provider. ```hcl data "coder_parameter" "setup_script" { diff --git a/docs/ai-coder/tasks-migration.md b/docs/ai-coder/tasks-migration.md index d489c1d474..6cd02ba2e7 100644 --- a/docs/ai-coder/tasks-migration.md +++ b/docs/ai-coder/tasks-migration.md @@ -50,7 +50,8 @@ module "claude-code" { 1. Add the `coder_ai_task` resource and set `app_id` to the `task_app_id` output of the Claude module. -> [!NOTE] Refer to the documentation for the specific module you are using for the exact name of the output. +> [!NOTE] +> Refer to the documentation for the specific module you are using for the exact name of the output. ```diff resource "coder_ai_task" "task" { diff --git a/docs/ai-coder/tasks.md b/docs/ai-coder/tasks.md index c5235b208e..ae9bc8f4e6 100644 --- a/docs/ai-coder/tasks.md +++ b/docs/ai-coder/tasks.md @@ -45,7 +45,8 @@ To import the template and begin configuring it, import the example [Run Coder T A template becomes a Task-capable template if it defines a `coder_ai_task` resource. Coder analyzes template files during template version import to determine if these requirements are met. Try adding this terraform block to an existing template where you'll add our Claude Code module. -> [!NOTE] The `coder_ai_task` resource is not defined within the [Claude Code Module](https://registry.coder.com/modules/coder/claude-code?tab=readme). You need to define it yourself. +> [!NOTE] +> The `coder_ai_task` resource is not defined within the [Claude Code Module](https://registry.coder.com/modules/coder/claude-code?tab=readme). You need to define it yourself. ```hcl terraform { @@ -121,7 +122,8 @@ Because Tasks run unpredictable AI agents, often for background tasks, we recomm Alternatively, follow our guide for [custom agents](./custom-agents.md). -> [!IMPORTANT] Upgrading from Coder v2.27 or earlier? See the [Tasks Migration Guide](./tasks-migration.md) for breaking changes in v2.28.0. +> [!IMPORTANT] +> Upgrading from Coder v2.27 or earlier? See the [Tasks Migration Guide](./tasks-migration.md) for breaking changes in v2.28.0. ## Customizing the Task UI