Skip to content

Commit 98eef78

Browse files
committed
tweak docs
1 parent 75a4e90 commit 98eef78

1 file changed

Lines changed: 14 additions & 89 deletions

File tree

docs/src/content/docs/reference/engines.md

Lines changed: 14 additions & 89 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@ The Copilot engine does not have built-in `web-search` support. You can add web
3434
**Environment Variables:**
3535
- **`COPILOT_MODEL`**: Alternative way to set the model (e.g., `gpt-5`)
3636

37-
#### Secrets
37+
**Secrets:**
3838

39-
- `COPILOT_CLI_TOKEN` secret is required for authentication.
39+
- **`COPILOT_CLI_TOKEN`** secret is required for authentication.
4040

4141
Please [create a GitHub Personal Access Token (PAT) for an account with a GitHub Copilot subscription](https://github.com/settings/tokens) and add this as a repository secret:
4242

4343
```bash
4444
gh secret set COPILOT_CLI_TOKEN -a actions --body "<your-github-pat>"
4545
```
4646

47-
- `GITHUB_MCP_TOKEN` secret (optional) is required when using remote mode for GitHub tools.
47+
- **`GITHUB_MCP_TOKEN`** secret (optional) is required when using remote mode for GitHub tools.
4848

4949
If you use `mode: remote` for GitHub tools (for faster startup without Docker), you'll need a separate GitHub Personal Access Token:
5050

@@ -74,17 +74,17 @@ engine:
7474
DEBUG_MODE: "true"
7575
```
7676

77-
#### Secrets
77+
**Secrets:**
7878

79-
- `ANTHROPIC_API_KEY` secret is required for authentication.
79+
- **`ANTHROPIC_API_KEY`** secret is required for authentication.
8080

8181
Use this to set the secret for your repo:
8282

8383
```bash
8484
gh secret set ANTHROPIC_API_KEY -a actions --body "<your-anthropic-api-key>"
8585
```
8686

87-
- `GITHUB_MCP_TOKEN` secret (optional) is required when using remote mode for GitHub tools.
87+
- **`GITHUB_MCP_TOKEN`** secret (optional) is required when using remote mode for GitHub tools.
8888

8989
If you use `mode: remote` for GitHub tools (for faster startup without Docker), you'll need a GitHub Personal Access Token:
9090

@@ -120,27 +120,22 @@ engine:
120120
retries = 3
121121
```
122122

123-
**Features:**
124-
- Code-focused AI engine
125-
- Generates `config.toml` for MCP server configuration
126-
- Supports custom TOML configuration via `config` field
127-
- Configurable user agent for GitHub MCP server
128-
- Requires `CODEX_API_KEY` or `OPENAI_API_KEY` secret
129-
130123
**Codex-specific fields:**
131124
- **`user-agent`** (optional): Custom user agent string for GitHub MCP server configuration
132125
- **`config`** (optional): Additional TOML configuration text appended to generated config.toml
133126

134-
#### Secrets
127+
**Secrets:**
135128

136-
- `OPENAI_API_KEY` secret is required for authentication.
129+
- **`OPENAI_API_KEY`** secret is required for authentication.
137130

138131
Use this to set the secret for your repo:
139132

140133
```bash
141134
gh secret set OPENAI_API_KEY -a actions --body "<your-openai-api-key>"
142135
```
143136

137+
The Codex engine supports additional customization through the `config` field, which allows you to append raw TOML configuration to the generated `config.toml` file.
138+
144139
### Custom Engine
145140

146141
For advanced users who want to define completely custom GitHub Actions steps instead of using AI interpretation.
@@ -163,9 +158,7 @@ engine:
163158
- No AI interpretation - direct step execution
164159
- Useful for deterministic workflows or hybrid approaches
165160

166-
## Engine-Specific Configuration
167-
168-
### Environment Variables
161+
## Engine Environment Variables
169162

170163
All engines support custom environment variables through the `env` field:
171164

@@ -178,15 +171,9 @@ engine:
178171
CUSTOM_API_ENDPOINT: https://api.example.com
179172
```
180173

181-
**Common use cases:**
182-
- Override default API keys (e.g., `OPENAI_API_KEY` for Codex)
183-
- Set region-specific configuration
184-
- Enable debug modes
185-
- Configure custom endpoints
186-
187-
### Error Patterns
174+
## Engine Error Patterns
188175

189-
Claude, Copilot, and Codex engines support custom error pattern recognition for enhanced log validation:
176+
All engines support custom error pattern recognition for enhanced log validation:
190177

191178
```yaml
192179
engine:
@@ -198,68 +185,6 @@ engine:
198185
description: "Custom error format with timestamp"
199186
```
200187

201-
## Codex Engine Advanced Configuration
202-
203-
The Codex engine supports additional customization through the `config` field, which allows you to append raw TOML configuration to the generated `config.toml` file.
204-
205-
### Custom Configuration Example
206-
207-
```yaml
208-
engine:
209-
id: codex
210-
config: |
211-
# Custom logging configuration
212-
[logging]
213-
level = "debug"
214-
file = "/tmp/gh-aw/codex-debug.log"
215-
216-
# Server timeout settings
217-
[server]
218-
timeout = 120
219-
max_connections = 10
220-
221-
# Custom tool configurations
222-
[tools.custom_analyzer]
223-
enabled = true
224-
mode = "strict"
225-
```
226-
227-
### Generated Output
228-
229-
This configuration generates a `config.toml` file with the structure:
230-
231-
```toml
232-
[history]
233-
persistence = "none"
234-
235-
[mcp_servers.github]
236-
user_agent = "workflow-name"
237-
command = "docker"
238-
args = ["run", "-i", "--rm", "-e", "GITHUB_PERSONAL_ACCESS_TOKEN", "ghcr.io/github/github-mcp-server:sha-09deac4"]
239-
env = { "GITHUB_PERSONAL_ACCESS_TOKEN" = "${{ secrets.GITHUB_TOKEN }}" }
240-
241-
# Custom configuration
242-
[logging]
243-
level = "debug"
244-
file = "/tmp/gh-aw/codex-debug.log"
245-
246-
[server]
247-
timeout = 120
248-
max_connections = 10
249-
250-
[tools.custom_analyzer]
251-
enabled = true
252-
mode = "strict"
253-
```
254-
255-
### Best Practices for Custom Config
256-
257-
1. **Validate TOML**: Ensure your configuration is valid TOML syntax
258-
2. **Avoid conflicts**: Don't override standard sections like `[history]` or `[mcp_servers.*]`
259-
3. **Use descriptive sections**: Name your configuration sections clearly
260-
4. **Document purpose**: Include comments in your TOML to explain custom settings
261-
5. **Test thoroughly**: Validate that your custom configuration works as expected
262-
263188
## Migration Between Engines
264189

265190
Switching between engines is straightforward - just change the `engine` field in your frontmatter:
@@ -280,7 +205,7 @@ engine:
280205
version: latest
281206
```
282207

283-
Note that engine-specific features (like `config` for Codex, `max-turns` for Claude, or `model` for Copilot) may not be available when switching engines.
208+
Note that engine-specific features may not be available when switching engines.
284209

285210
## Related Documentation
286211

0 commit comments

Comments
 (0)