Skip to content

docs: fix documentation drift — engine_log_dir path and ado/mod.rs lifecycle commands #601

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jamesadevine merged 1 commit into from
May 17, 2026
Merged

docs: fix documentation drift — engine_log_dir path and ado/mod.rs lifecycle commands #601

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ Every compiled pipeline runs as three sequential jobs:
│ ├── configure.rs # `configure` CLI command — orchestration shim atop `src/ado/`
│ ├── enable.rs # `enable` CLI command — registers ADO build definitions for compiled pipelines and ensures they are enabled
│ ├── ado/ # Shared Azure DevOps REST helpers (auth, list/match/PATCH/POST)
│ │ └── mod.rs # Used by `configure` and the lifecycle commands (enable, disable, remove, list, run, status, secrets)
│ │ └── mod.rs # Used by `configure` and the `enable` command (ADO REST helpers: auth, list/match/PATCH/POST)
│ ├── detect.rs # Agentic pipeline detection (helper for `configure`)
│ ├── ndjson.rs # NDJSON parsing utilities
│ ├── sanitize.rs # Input sanitization for safe outputs
Expand Down
4 changes: 3 additions & 1 deletion docs/template-markers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,9 @@ ADO access tokens (`AZURE_DEVOPS_EXT_PAT`, `SYSTEM_ACCESSTOKEN`) are not part of

## {{ engine_log_dir }}

Should be replaced with the engine's log directory path, generated by `Engine::log_dir()`. For Copilot: `~/.copilot/logs`. Used by log collection steps to copy engine logs to pipeline artifacts.
Should be replaced with the engine's log directory path, generated by `Engine::log_dir()`. For Copilot: `$HOME/.copilot/logs`. Used by log collection steps to copy engine logs to pipeline artifacts.

> **Note:** `$HOME` is used instead of `~` because tilde does not expand inside double-quoted strings in bash. Using `~` would cause the directory check (`[ -d "~/.copilot/logs" ]`) to always fail, silently preventing log collection.

## {{ pool }}

Expand Down