Skip to content

docs: point reverse-attach links at openab-computer after rename - #82

Open
chaodu-agent wants to merge 1 commit into
mainfrom
docs/rename-to-openab-computer
Open

chaodu-agent wants to merge 1 commit into
mainfrom
docs/rename-to-openab-computer

Conversation

@chaodu-agent

Copy link
Copy Markdown
Collaborator

This PR updates the reverse-attach documentation links after the rename of the
instance-mcp repository to openab-computer.

Changes:

  • Retarget the reverse-attach ADR link from openabdev/instance-mcp to
    openabdev/openab-computer in README.md, docs/k8s-howto.md,
    runtime/CLIENT-CONTRACT.md and the module doc comment in runtime/src/tools.rs.
  • Reword comment and prose lines in Dockerfile, deploy/ecs/entrypoint.sh and
    deploy/k8s/pod-tailscale.yaml so they name OpenAB Computer instead of
    instance-mcp.

No commands, paths, identifiers, binary names or release asset names change.
Docs and comments only, so no build or test run is needed for this change.

Refs openabdev/openab-computer#63
Discord Discussion URL: Not applicable - maintainer-filed rename docs step tracked in openabdev/openab-computer#63.

@chaodu-agent

Copy link
Copy Markdown
Collaborator Author

Important

CHANGES REQUESTED ⚠️ - The file changes are correct and match the rename decision; the one blocker is a commit message that claims a CLIENT-CONTRACT.md prose change the diff does not contain.

What This PR Does

The instance-mcp repository was renamed to openabdev/openab-computer. This PR points the reverse-attach design references at the new repository and changes three comment lines to use the product name "OpenAB Computer" instead of the bare old repository name. The executable name oab-instance-mcp stays unchanged on purpose.

How It Works

The PR is one commit that changes one line in each of 7 files (7 insertions, 7 deletions). All changes are in Markdown, Rust //! doc comments, a Dockerfile comment, a shell heredoc comment, and a YAML comment. No command, path, env var, config key, bundle id, or release asset name changes.

  • URL retargets: README.md:100, docs/k8s-howto.md:152, and runtime/CLIENT-CONTRACT.md:286 now link to https://github.com/openabdev/openab-computer/blob/main/docs/adr/reverse-attach.md. runtime/src/tools.rs:5 now names the repository openabdev/openab-computer.
  • Product-name prose: Dockerfile:120, deploy/ecs/entrypoint.sh:74, and deploy/k8s/pod-tailscale.yaml:110 change "instance-mcp" to "OpenAB Computer".

Findings

# Severity Finding Location
F1 🟡 The commit message says the section 9 prose in CLIENT-CONTRACT.md now names OpenAB Computer, but the diff only changes the link in that file commit 083a628 message; runtime/CLIENT-CONTRACT.md:285
F2 🟢 Every old repository reference now points at openabdev/openab-computer, and no openabdev/instance-mcp reference remains in the tree README.md:100, docs/k8s-howto.md:152, runtime/CLIENT-CONTRACT.md:286, runtime/src/tools.rs:5
F3 🟢 No executable name, bundle id, config path, env var, or release asset name was renamed; every oab-instance-mcp mention is unchanged README.md:95, docs/k8s-howto.md:145, runtime/CLIENT-CONTRACT.md:285, runtime/src/tools.rs:1, runtime/tests/tools_e2e.rs:337
F4 🟢 The prose rewording uses the correct product name and keeps comment syntax and indentation intact Dockerfile:120, deploy/ecs/entrypoint.sh:74, deploy/k8s/pod-tailscale.yaml:110
Finding Details

🟡 F1: Commit message describes a change that is not in the diff

The body of commit 083a628bfa6660d2b041cf57cce93f4cfb36caf1 contains this line:

- runtime/CLIENT-CONTRACT.md: same ADR link retargeted; section 9 prose names OpenAB Computer

The diff for runtime/CLIENT-CONTRACT.md changes only line 286, the link. Section 9 ("Tools attach - a Mac lends its tools to one session", line 281) does not mention OpenAB Computer at the head SHA, and line 285 still reads `oab-instance-mcp` on a Mac. Design of record:. Keeping line 285 is correct, because it names the executable, which the rename decision keeps. The commit message is what is wrong: if it lands as written, git log records a prose change that never happened. The PR body is accurate and lists CLIENT-CONTRACT.md only under the link retarget.

Verified by the coordinator with git log -1 --format=%B 083a628 and git diff 7f46387 083a628 -- runtime/CLIENT-CONTRACT.md.

Suggested fix: Reword the line to - runtime/CLIENT-CONTRACT.md: same ADR link retargeted. Either amend and push, or use the corrected text as the squash-merge message. No file content needs to change.

🟢 F2: Repository references are complete

git grep -n -i -E 'instance[ -]?mcp' at the head SHA returns only the five oab-instance-mcp executable mentions listed in F3. No openabdev/instance-mcp URL or repository reference remains. The same new URL is used in all three Markdown links, and docs/adr/reverse-attach.md exists on main of openabdev/openab-computer, so the links resolve without relying on GitHub's rename redirect. Other github.com/openabdev/... links in the tree point at unrelated repositories and correctly stay unchanged.

🟢 F3: Fixed identifiers are preserved

The diff leaves unchanged the oab-instance-mcp executable name, the PTY_TOOLS_LISTEN, PTY_TOOLS_ATTACH_TTL, and OPENAB_TOOLS_MCP_URL env vars, the tools_listen and tools_attach_ttl config keys, the /tools/attach/{session} path, and the computer MCP server key in deploy/hooks/startup-hook.sh. None of the 7 changed lines touches a command, path, or identifier. git diff --check reports no whitespace errors.

🟢 F4: Prose rename is accurate

The old comments used the bare repository name instance-mcp (no oab- prefix, no backticks) as a product name, so "OpenAB Computer" is the right replacement. Where the docs refer to the binary (README.md:95, runtime/src/tools.rs:1), they keep the backticked oab-instance-mcp. The split between product name and executable name is consistent across the tree.

Reviewer Verdicts

Reviewer Status Verdict Findings
Reviewer A ok LGTM ✅ Rename boundaries applied consistently (merged into F2, F3, F4)
Reviewer B ok CHANGES REQUESTED ⚠️ Commit message mismatch (F1); URLs, identifiers, and prose correct (F2, F3, F4)

The coordinator reproduced F1 against the head SHA, so it stays at 🟡. Reviewer A did not report it; its file-content checks agree with F2 to F4. No findings were dropped or downgraded.

Addressing External Reviewer Feedback

No external review comments or GitHub reviews exist on this PR at the time of this round.

5. Three Reasons We Might Not Need This PR

  1. The redirect already works - GitHub redirects openabdev/instance-mcp URLs to the renamed repository, so the old links were not broken. The counterpoint is that the redirect stops working if a new openabdev/instance-mcp repository is ever created.
  2. The change has no runtime effect - Only docs and comments change, so deployments and clients behave the same with or without this PR.
  3. Two names now coexist - Comments say "OpenAB Computer" while other lines keep oab-instance-mcp, which may confuse readers who do not know the binary belongs to the product. The counterpoint is that the rename decision keeps the executable name on purpose, and the new repository README pairs both names.
Baseline Check
  • PR opened: 2026-10-29T16:40:46Z
  • Head SHA: 083a628bfa6660d2b041cf57cce93f4cfb36caf1
  • Head branch: docs/rename-to-openab-computer
  • Base branch: main (not stacked)
  • Merge-base: 7f463874342533b33e9a3a6a53d5cf6c14572ef9
  • Diff stat: 7 files changed, 7 insertions(+), 7 deletions(-); one commit
  • Main already has: the reverse-attach docs and comments, with links that work only through GitHub's rename redirect and prose that uses the old repository name
  • Net-new value: canonical links to openabdev/openab-computer and product-name prose aligned with the rename
  • Validation scope: read-only diff and head-tree inspection; no build or tests run (docs and comments only)
  • Note outside the diff (not a finding): the PR body says Refs openabdev/instance-mcp#63. GitHub follows the redirect, so no change is required; openabdev/openab-computer#63 is the canonical form.
What's Good (🟢)
  • Tight scope: one line per file, only comments, docs, and URLs.
  • The PR body states the rename boundary explicitly, and the diff matches it.
  • Product name and executable name are kept distinct throughout.
  • No stale reference to the old repository remains anywhere in the head tree.

The instance-mcp repository was renamed to openabdev/openab-computer.
This commit retargets the reverse-attach ADR references to the new name
and changes three prose comments to say "OpenAB Computer".

Changes, 7 files, 1 insertion and 1 deletion each:
- README.md:100: reverse-attach ADR link now points at openabdev/openab-computer.
- docs/k8s-howto.md:152: same ADR link retargeted.
- runtime/CLIENT-CONTRACT.md:286: same ADR link retargeted. Only the link
  changes in section 9; the surrounding prose is not modified.
- runtime/src/tools.rs:5: module doc comment ADR reference now names
  openabdev/openab-computer.
- Dockerfile:120: comment prose "instance-mcp tools" -> "OpenAB Computer tools".
- deploy/ecs/entrypoint.sh:74: comment prose -> "OpenAB Computer tools".
- deploy/k8s/pod-tailscale.yaml:110: comment prose -> "OpenAB Computer".

Not changed: executable oab-instance-mcp, bundle id dev.openab.instance-mcp,
config and log paths, LaunchAgent labels, release asset names, and
docs/adr/ files. No build or test was run; the diff touches only
comments, docs, and GitHub URLs.
@chaodu-agent
chaodu-agent force-pushed the docs/rename-to-openab-computer branch from 083a628 to d3e6a4c Compare October 29, 2026 18:29
@chaodu-agent

Copy link
Copy Markdown
Collaborator Author

Note

LGTM ✅ - The seven one-line doc and comment changes retarget the reverse-attach links to openabdev/openab-computer, and the rewritten commit message now describes the diff exactly.

What This PR Does

The instance-mcp repository was renamed to openabdev/openab-computer. This PR updates the links and prose comments in this repo that still pointed at the old name, so readers land on the right repository.

How It Works

Seven files change by one line each. Four lines retarget the reverse-attach ADR link or repository reference to openabdev/openab-computer (README.md:100, docs/k8s-howto.md:152, runtime/CLIENT-CONTRACT.md:286, runtime/src/tools.rs:5). Three comment lines now say "OpenAB Computer" (Dockerfile:120, deploy/ecs/entrypoint.sh:74, deploy/k8s/pod-tailscale.yaml:110). Fixed identifiers are deliberately left alone: the oab-instance-mcp executable, the dev.openab.instance-mcp bundle id, config and log paths, LaunchAgent labels, release asset names, and docs/adr/ files.

Findings

# Severity Finding Location
F1 🟢 Previous-round blocker fixed: the commit message now says only the link changes in section 9 of CLIENT-CONTRACT.md, which matches the diff runtime/CLIENT-CONTRACT.md:286
F2 🟢 The force-push changed only commit metadata; the tree is identical before and after -
F3 🟢 Every changed line is a link retarget or a prose rename; no fixed identifier or asset name is touched -
F4 🟢 The commit message matches the diff line by line, including file count, line numbers, and the "not changed" list -
Finding Details

🟢 F1: Previous-round blocker fixed

The previous review (on 083a628) found that the commit message claimed a section 9 prose change in runtime/CLIENT-CONTRACT.md that the diff did not contain. The new message reads: "Only the link changes in section 9; the surrounding prose is not modified." The hunk @@ -285,3 +285,3 changes only line 286, and line 285 still names oab-instance-mcp.

🟢 F2: Metadata-only rewrite

083a628 and d3e6a4c both have tree 23e5446c3af4476799f67b87032254c7f298c375, and git diff 083a628..d3e6a4c is empty. The file-content conclusions of the previous review still hold.

🟢 F3: Scope limited to links and prose

The removed lines mention instance-mcp only in prose and repository URLs. None of the added or removed lines contain oab-instance-mcp, dev.openab.instance-mcp, ~/.config/oab-instance-mcp, or release asset names. git diff --check is clean.

🟢 F4: Accurate commit message

"7 files, 1 insertion and 1 deletion each" matches --numstat. All seven listed line numbers match the changed lines, and nothing in the "not changed" list appears in the diff.

Reviewer Verdicts

Reviewer Verdict Findings
Reviewer A LGTM ✅ F1, F2
Reviewer B LGTM ✅ F1, F2, F3, F4

Three Reasons We Might Not Need This PR

  1. GitHub redirects renamed repositories - Links to the old instance-mcp URL keep working through GitHub's rename redirect, so readers would still reach the ADR without this change.
  2. Mixed naming remains - The executable, bundle id, and paths still say instance-mcp, so the repo keeps both names either way. Changing only prose may not reduce confusion much.
  3. Low user impact - Three of the seven lines are internal comments in deploy files that end users rarely read.

The redirect can break if a new repository ever takes the old name, and the fixed identifiers are kept on purpose for compatibility, so the PR is still worth merging.

Baseline Check
  • PR opened: 2026-10-29
  • Head SHA: d3e6a4c8a655e50351eb046c9fea9806d89ead02
  • Base: main
  • Merge-base: 7f463874342533b33e9a3a6a53d5cf6c14572ef9
  • Diff stat: 7 files changed, 7 insertions(+), 7 deletions(-)
  • Net-new value: main still links to the old repository name in these seven places.
  • No build or test suite was run; the diff touches only comments, docs, and GitHub URLs.

Reviewers: Reviewer A and Reviewer B

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant