Repository navigation
docs: rename remote-instances.md to remote-crew.md with redirect - #12752
Conversation
c265e37 to
cda40f9
Compare
|
CI status — one infra flake, zero findings against the diff:
A re-run of the Fast Gate workflow should clear all three. The four fork review workflows are also awaiting maintainer approval. Nothing on my side to change; happy to rebase-retrigger if main moves first. |
cda40f9 to
a4a6e1a
Compare
GPT 5.6 Review (fork) — ✅ no blocking findingsReviewed Review detailsNo findings. |
Design Review (Fable 5, fork) — ✅ PASSDesign-level review of Design-Verdict: PASS Nothing to check. [DESIGN-REVIEWED] f276afe |
Opus 4.8 Review (fork) — ✅ no blocking findingsReviewed |
First Principles Review (Fable 5, fork) — ✅ PASSPremise-level review of First-Principles-Verdict: PASS Verify issue #12750's text sanctions the stub fallback and the identifier exclusions — every other claim checks out against the base tree. What this change shipsInventory (5 items) — 5 justifiedIntent: FIX — finish merged #12697's rename so the Remote Crew page's filename matches its name, without breaking published links (follow-up issue #12750).
Checks run: [FIRST-PRINCIPLES-REVIEWED] f276afe |
|
First Principles BLOCK acknowledged — it is an ordering dependency, not a defect in this diff: the lane reads the base spec ( Per the lane's own clear condition: once #12697 merges, I will rebase this branch onto main so the run reads the merged naming record — the content edits #12697 makes to Note for maintainers: #12697 currently shows merge conflicts against main and needs a rebase on its side first. |
a4a6e1a to
303740c
Compare
303740c to
932a259
Compare
|
This round's backend reds are main breakage, not this diff: Meanwhile all four AI review lanes are green on this diff (First Principles flipped BLOCK→PASS after rebasing onto the merged #12697, per its stated clear condition), Docs Lint passes, and the earlier Windows flakes (#12685 port-identity, #12359 runtime-cleanup) rotated out this round. I'll rebase once #12852 is fixed on main. |
932a259 to
4f0d0f2
Compare
4f0d0f2 to
98d3fcb
Compare
The Remote Crew feature's page kept its remote-instances filename after the kirodotdev#12697 vocabulary pass because the filename is a published URL. Rename it to remote-crew.md and leave a stub at the old path so existing links keep resolving. There is no docs site generator in this repository — these pages ship inside the Python package and are linked externally as GitHub blob URLs — so no true redirect mechanism exists; the stub page is the fallback the issue sanctions for that case. Referring links in index.md and README.md now target remote-crew.md, and test_remote_instances_doc.py moves to test_remote_crew_doc.py with its pinned path updated. The test/gui_user scenario slug and backend 'instance' vocabulary are deliberately untouched. Fixes kirodotdev#12750
98d3fcb to
f276afe
Compare
…odotdev#12752) The Remote Crew feature's page kept its remote-instances filename after the kirodotdev#12697 vocabulary pass because the filename is a published URL. Rename it to remote-crew.md and leave a stub at the old path so existing links keep resolving. There is no docs site generator in this repository — these pages ship inside the Python package and are linked externally as GitHub blob URLs — so no true redirect mechanism exists; the stub page is the fallback the issue sanctions for that case. Referring links in index.md and README.md now target remote-crew.md, and test_remote_instances_doc.py moves to test_remote_crew_doc.py with its pinned path updated. The test/gui_user scenario slug and backend 'instance' vocabulary are deliberately untouched. Fixes kirodotdev#12750 Co-authored-by: Wael Dimassi <ydimawae@amazon.com>
Problem / Motivation
#12697 has merged: the page's content and the
instances.mdnaming record now say "Remote Crew", but the filename still saysremote-instances. This PR is the follow-up #12697's design review asked to be filed (#12750): rename the file to match, without breaking published links. This branch is rebased on top of the merged #12697, and the renamedremote-crew.mdcarries #12697's content byte-for-byte; the stub and both index rows use the merged "Remote Crew" labels, so no displayed string says "Remote Instances" anywhere in the diff.Why it matters
The filename is the page's address: it is what
index.mdandREADME.mdlink to and what external links (GitHub blob URLs) point at. Left unrenamed, the feature's page permanently carries the retired name.What changed (motivation → approach → change)
Goal: rename the file without breaking any existing link to it.
Mechanism check first, as the issue asks: this repository has no docs site generator — no mkdocs/docusaurus/sphinx config anywhere, and
.github/workflows/pages.ymlpublishes only the marketing site insite/. These docs ship inside the Python package (read in-app; the tips catalog scans them) and are linked externally as GitHub blob URLs (e.g. fromcli_doctor.pyand the settings panels). Neither surface has a redirect facility, andgit log --diff-filter=Rshows no prior doc rename to follow as precedent. So this PR uses the fallback the issue sanctions:git mv src/kiro_crew/docs/remote-instances.md src/kiro_crew/docs/remote-crew.md(rename detected, history follows).index.md(two rows) andREADME.mdnow targetremote-crew.md; the README row also links the stub so it stays reachable from the directory index (docs-lint's reachability gate).test/test_remote_instances_doc.py→test/test_remote_crew_doc.py, with its pinnedDOCpath and docstring updated — the rename the issue calls reasonable in the same change.Deliberately untouched, per the issue: page content (that is #12697's job — it is still open and touches this file, so whichever lands second rebases; git's rename detection carries content edits into the new filename), the
test/gui_userscenario slugremote-instances(a stored identifier, not displayed copy), and the wider backend "instance" vocabulary (instances.json,apps.mochi.instances.*, backend keys and routes).Backwards compatibility
Compatible: every existing link to
src/kiro_crew/docs/remote-instances.mdstill resolves — the old path now holds a stub that points at the new page. In-repo referrers were swept (git grep -n "remote-instances"): all doc links updated here; the remaining matches are the gui_user slug (stored identifier, out of scope per the issue) and a code comment inwebsite/electron/mochi/pet-preload.jsthat refers to a panelBridge code note, not this file.Tests
test/test_remote_crew_doc.py(renamed fromtest_remote_instances_doc.py) keeps pinning the page's code-coupled claims, now at the new path — all 11 tests pass locally../scripts/docs-lint.shpasses: it validates that every link resolves (old references would fail it) and that both the renamed page and the stub are reachable from the directory index.Manual verification
Verified the stub's link and both index links resolve relative to
src/kiro_crew/docs/(same directory, checked by docs-lint's link resolution), the renamed page's own relative links (../../../docs/guides/...) are unaffected since the file stays in the same directory, andgit log --followtraces the renamed file's history back through #12581.Related Issues
Fixes #12750
Checklist
feat|fix|docs|refactor|perf|test|chore|ci|build|revert: ...)Contribution License Agreement