githubnext / githubnext/ado-aw

docs(prompts): use repo-relative paths instead of hardcoded absolute checkout paths

Open
#1,763 0 comments 0 reactions 0 assignees View on GitHub
agentic-workflows docs documentation
Dominant language
Rust
Stars
23
Forks
8
Avg merge
4d 9h
Merged PRs (30d)
22

Description

## Agent Documentation Update

### Findings

| Area | Issue | File(s) |
|------|-------|---------|
| accuracy | Workflow-authoring prompt guides hardcoded an absolute path (`/home/runner/work/ado-aw/ado-aw/...`) from a specific CI runner checkout when referencing `prompt-contract.md` and `docs/*.md` reference pages. These references drive `ado-aw` agent behavior and break for any agent or contributor working from a different checkout path (e.g. `/repo`, a different clone directory, or a consumer repo that vendors these prompts). | `prompts/create-ado-agentic-workflow.md`, `prompts/update-ado-agentic-workflow.md`, `prompts/debug-ado-agentic-workflow.md` |

### Applied Fixes

- [x] Replaced `/home/runner/work/ado-aw/ado-aw/prompts/prompt-contract.md` with `./prompt-contract.md` in all three prompt files
- [x] Replaced `/home/runner/work/ado-aw/ado-aw/docs/.md` with `../docs/.md` (correct relative path from `prompts/` to `docs/`) for all doc cross-references in the three prompt files

### Notes

Verified the absolute paths were unique to `prompts/create-ado-agentic-workflow.md`, `prompts/debug-ado-agentic-workflow.md`, and `prompts/update-ado-agentic-workflow.md` (not present in `prompts/prompt-contract.md` or elsewhere). Confirmed `docs/` and `prompts/` are sibling directories at the repo root, so `../docs/.md` resolves correctly from any file in `prompts/`. Ran `realpath --relative-to=prompts docs/front-matter.md` to confirm the relative path form. No other documentation inaccuracies of comparable severity were found in this pass (CLI docs, safe-outputs docs, front-matter docs, and the AGENTS.md doc index were all cross-checked against `src/main.rs`, `src/safe_outputs/`, and `src/compile/types.rs` and found accurate).

---
*Created by the agent-documentation maintainer workflow.*

> Generated by [Agent Documentation Maintainer](https://github.com/githubnext/ado-aw/actions/runs/30664175443) · aut00 · 96.9 AIC · ⌖ 11.7 AIC · ⊞ 13K · [◷](https://github.com/search?q=repo%3Agithubnext%2Fado-aw+%22gh-aw-workflow-id%3A+doc-freshness-check%22&type=pullrequests)

---

> [!NOTE]
> This was originally intended as a pull request, but the git push operation failed.
>
> **Original error:** pushSignedCommits: failed to rebase commit range onto current GraphQL parent (675732524e027e5dee81c874e49dfbb781b8b13f). Resolve conflicts by rebasing/cherry-picking locally and retry. Root cause: Auto-merging prompts/create-ado-agentic-workflow.md CONFLICT (content): Merge conflict in prompts/create-ado-agentic-workflow.md Auto-merging prompts/debug-ado-agentic-workflow.md CONFLICT (content): Merge conflict in prompts/debug-ado-agentic-workflow.md Auto-merging prompts/update-ado-agentic-workflow.md CONFLICT (content): Merge conflict in prompts/update-ado-agentic-workflow.md Rebasing (1/1) error: could not apply a15be16... docs(prompts): use repo-relative paths instead of hardcoded absolute checkout paths hint: Resolve all conflicts manually, mark them as resolved with hint: "git add/rm (conflicted_files)", then run "git rebase --continue". hint: You can instead skip this commit: run "git rebase --skip". hint: To abort and get back to the state before "git rebase", run "git rebase --abort". hint: Disable this message with "git config set advice.mergeConflict false" Could not apply a15be16... # docs(prompts): use repo-relative paths instead of hardcoded absolute checkout paths
>
> **Workflow Run:** [View run details and download bundle artifact](https://github.com/githubnext/ado-aw/actions/runs/30664175443)
>
> The bundle file is available in the `agent` artifact in the workflow run linked above.

To create a pull request with the changes:

```sh
# Download the artifact from the workflow run
gh run download 30664175443 -n agent -D /tmp/agent-30664175443

# Fetch the bundle into a temporary ref, then update the local branch
git fetch /tmp/agent-30664175443/aw-docs-fix-hardcoded-prompt-paths.bundle refs/heads/docs/fix-hardcoded-prompt-paths:refs/bundles/create-pr-docs-fix-hardcoded-prompt-paths-6af5ee52f8075cdf-14c0313f
git update-ref refs/heads/docs/fix-hardcoded-prompt-paths-6af5ee52f8075cdf refs/bundles/create-pr-docs-fix-hardcoded-prompt-paths-6af5ee52f8075cdf-14c0313f
git checkout docs/fix-hardcoded-prompt-paths-6af5ee52f8075cdf
# Ensure the working tree matches the updated branch
git reset --hard
# Remove the temporary bundle ref
git update-ref -d refs/bundles/create-pr-docs-fix-hardcoded-prompt-paths-6af5ee52f8075cdf-14c0313f

# Push the branch to origin
git push origin docs/fix-hardcoded-prompt-paths-6af5ee52f8075cdf

# Create the pull request
gh pr create --title 'docs(prompts): use repo-relative paths instead of hardcoded absolute checkout paths' --base main --head docs/fix-hardcoded-prompt-paths-6af5ee52f8075cdf --repo githubnext/ado-aw
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Inspect prompts/create-ado-agentic-workflow.md, prompts/update-ado-agentic-workflow.md, and prompts/debug-ado-agentic-workflow.md, then review the failed-rebase details in the issue. Verify each prompt uses paths relative to its location and that no hardcoded checkout paths remain; resolve any conflicts while preserving the prompt content.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.