Skip to content

Commit fa4505f

Browse files
committed
chore: polish some modules readme
1 parent e1f077d commit fa4505f

File tree

3 files changed

+7
-31
lines changed

3 files changed

+7
-31
lines changed

registry/coder/modules/agentapi/README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
---
22
display_name: AgentAPI
3-
description: Building block for modules that need to run an agentapi server
3+
description: Building block for modules that need to run an AgentAPI server
44
icon: ../../../../.icons/coder.svg
55
verified: true
6-
tags: [internal]
6+
tags: [internal, library]
77
---
88

99
# AgentAPI
1010

11-
The AgentAPI module is a building block for modules that need to run an agentapi server. It is intended primarily for internal use by Coder to create modules compatible with Tasks.
11+
> [!CAUTION]
12+
> We do not recommend using this module directly. Instead, please consider using one of our [Tasks-compatible AI agent modules](https://registry.coder.com/modules?search=tag%3Atasks).
1213
13-
We do not recommend using this module directly. Instead, please consider using one of our [Tasks-compatible AI agent modules](https://registry.coder.com/modules?search=tag%3Atasks).
14+
The AgentAPI module is a building block for modules that need to run an AgentAPI server. It is intended primarily for internal use by Coder to create modules compatible with Tasks.
1415

1516
```tf
1617
module "agentapi" {
@@ -50,4 +51,4 @@ module "agentapi" {
5051

5152
## For module developers
5253

53-
For a complete example of how to use this module, see the [goose module](https://github.com/coder/registry/blob/main/registry/coder/modules/goose/main.tf).
54+
For a complete example of how to use this module, see the [Goose module](https://github.com/coder/registry/blob/main/registry/coder/modules/goose/main.tf).

registry/coder/modules/aider/README.md

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -28,32 +28,6 @@ module "aider" {
2828
- **Browser UI**: Use Aider in your browser with a modern web interface instead of the terminal
2929
- **Non-Interactive Mode**: Automatically processes tasks when provided via the `task_prompt` variable
3030

31-
## Module Parameters
32-
33-
| Parameter | Description | Type | Default |
34-
| ---------------------------------- | -------------------------------------------------------------------------- | -------- | ------------------- |
35-
| `agent_id` | The ID of a Coder agent (required) | `string` | - |
36-
| `folder` | The folder to run Aider in | `string` | `/home/coder` |
37-
| `install_aider` | Whether to install Aider | `bool` | `true` |
38-
| `aider_version` | The version of Aider to install | `string` | `"latest"` |
39-
| `use_screen` | Whether to use screen for running Aider in the background | `bool` | `true` |
40-
| `use_tmux` | Whether to use tmux instead of screen for running Aider in the background | `bool` | `false` |
41-
| `session_name` | Name for the persistent session (screen or tmux) | `string` | `"aider"` |
42-
| `order` | Position of the app in the UI presentation | `number` | `null` |
43-
| `icon` | The icon to use for the app | `string` | `"/icon/aider.svg"` |
44-
| `experiment_report_tasks` | Whether to enable task reporting | `bool` | `true` |
45-
| `system_prompt` | System prompt for instructing Aider on task reporting and behavior | `string` | See default in code |
46-
| `task_prompt` | Task prompt to use with Aider | `string` | `""` |
47-
| `ai_provider` | AI provider to use with Aider (openai, anthropic, azure, etc.) | `string` | `"anthropic"` |
48-
| `ai_model` | AI model to use (can use Aider's built-in aliases like "sonnet", "4o") | `string` | `"sonnet"` |
49-
| `ai_api_key` | API key for the selected AI provider | `string` | `""` |
50-
| `custom_env_var_name` | Custom environment variable name when using custom provider | `string` | `""` |
51-
| `experiment_pre_install_script` | Custom script to run before installing Aider | `string` | `null` |
52-
| `experiment_post_install_script` | Custom script to run after installing Aider | `string` | `null` |
53-
| `experiment_additional_extensions` | Additional extensions configuration in YAML format to append to the config | `string` | `null` |
54-
55-
> **Note**: `use_screen` and `use_tmux` cannot both be enabled at the same time. By default, `use_screen` is set to `true` and `use_tmux` is set to `false`.
56-
5731
## Usage Examples
5832

5933
### Basic setup with API key

registry/coder/modules/amazon-q/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ module "amazon-q" {
1515
source = "registry.coder.com/coder/amazon-q/coder"
1616
version = "1.1.1"
1717
agent_id = coder_agent.example.id
18+
1819
# Required: see below for how to generate
1920
experiment_auth_tarball = var.amazon_q_auth_tarball
2021
}

0 commit comments

Comments
 (0)