SSH/Warpify docs information-architecture reframe (GROW-6121) - #648
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…t, hidden legacy page (GROW-6121) - ssh.mdx: rewrite the tmux-based Warpification section as a plain historical note (removed, not deprecated); trim the 11-item feature list to a short summary pointing to ssh-feature-support.mdx up front; add a fallback link to the legacy SSH wrapper in Requirements. - ssh-legacy.mdx: hide from the primary Warpify nav. Starlight's sidebar: hidden frontmatter has no effect in this repo since the sidebar is manually curated via starlight-sidebar-topics (src/sidebar.ts), so also remove the page from that list and associate it with the Terminal topic as an unlisted page via the topic frontmatter field, keeping it directly reachable by URL. - warpify/index.mdx: nest SSH Legacy under SSH as a single fallback clause instead of a co-equal numbered item. - all-settings.mdx: reword enable_legacy_ssh_wrapper and use_ssh_tmux_wrapper to state plainly that they have no effect on current behavior. Co-Authored-By: Warp <agent@warp.dev>
warp-agent-staging
Bot
changed the title
|
@warp-agent-staging[bot] I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
![warp-for-oss[bot]](https://avatars.githubusercontent.com/in/3450139?s=60&v=4){kind=small}
There was a problem hiding this comment.
Overview
This PR reframes the SSH/Warpify docs by hiding the legacy SSH wrapper from primary navigation, trimming duplicated SSH feature copy, and clarifying legacy settings. The structural direction matches the attached PR context, and the supplemental security pass found no security-specific findings.
Concerns
- The Requirements section now gives conflicting fallback behavior for unsupported hosts: the existing glibc requirement still says Warp falls back to a regular SSH session, while the new fallback sentence says Warp falls back to the legacy SSH wrapper.
Verdict
Found: 0 critical, 1 important, 0 suggestions
Request changes
Comment /warp-agent-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
…21 rework) Rework per review: the sidebar: hidden frontmatter has no effect in this repo (sidebar is manually curated via starlight-sidebar-topics), so it was dead weight. The topic: terminal frontmatter field is the actual mechanism keeping the page out of primary nav while associating it with the Terminal topic. Co-Authored-By: Warp <agent@warp.dev>
Co-Authored-By: Warp <agent@warp.dev>
Specs stay purely internal and are never published or committed into target repos. Removes .agents/specs/GROW-6121-ssh-warpify-ia-reframe.md from this PR; the reviewed/approved doc content changes are unaffected. Co-Authored-By: Warp <agent@warp.dev>
![warp-agent-staging[bot]](https://avatars.githubusercontent.com/in/2196476?s=60&v=4){kind=small}
There was a problem hiding this comment.
Overview
The rework fix, the spec-file removal, and the requester's direct copy-edit all landed cleanly — build, broken-link check, style_lint, and CI are all green with no new issues in the doc content itself.
Concerns
The PR description's Verification and Rework-changes sections are now stale: they still claim "exactly one new link to /terminal/warpify/ssh-legacy/ added" and don't mention the requester's own dcbc018f copy-edit commit, which added a second new link to ssh-legacy.mdx (see inline comment). Please refresh the description to reflect the current diff before merge.
Verdict
Checks: build ✅ · tests n/a (content-only) · CI ✅ · visual proof n/a (static docs content, no computer_use per factory-verification)
Found: 0 critical, 1 important (description staleness, above), 0 suggestions · 1 open question (inline)
Request changes — pending the open question below (the doc content itself is otherwise ready to merge once the description is refreshed and the question is resolved).
Review run
https://platform.staging.warp.dev/bOEZRU0oiK4KrUD6bKONxk/runs/01a044f3-a455-7e97-96fc-56a9388c1b1c
| * **Operating system** - Linux or macOS. Windows remote hosts are not supported. The extension is also not available from Warp's Windows client. | ||
| * **Architecture** - `x86_64` (amd64) or `aarch64` (arm64). | ||
| * **glibc 2.31 or newer (Linux)** - The prebuilt server binary requires glibc 2.31+ (Ubuntu 20.04 or equivalent). Hosts with an older glibc (for example RHEL/CentOS 7 and 8, Amazon Linux 2, Ubuntu 18.04, Debian 10) or a non-glibc libc (for example Alpine's musl) are not supported. Warp detects this before installing anything and quietly falls back to a regular SSH session. | ||
| * **glibc 2.31 or newer (Linux)** - The prebuilt server binary requires glibc 2.31+ (Ubuntu 20.04 or equivalent). Hosts with an older glibc (for example RHEL/CentOS 7 and 8, Amazon Linux 2, Ubuntu 18.04, Debian 10) or a non-glibc libc (for example Alpine's musl) are not supported. Warp detects this before installing anything and quietly falls back to the [legacy SSH wrapper](/terminal/warpify/ssh-legacy/). |
There was a problem hiding this comment.
❓ [QUESTION] This edit adds a second new link to /terminal/warpify/ssh-legacy/ in this same Requirements section — the trailing sentence added just below ("When a host doesn't meet these requirements... Warp falls back to the legacy SSH wrapper.") already covers this exact case. The approved spec's alignment round explicitly called for exactly one new link here to avoid scatter (validation criterion: "exactly one new link... and none elsewhere"). Is the duplication intentional (e.g. wanting the link inline at the specific failure condition, not just the summary), or should one of the two be dropped?
2 participants
Summary
Resolves the SSH/Warpify information-architecture decision carved out of GROW-6086 and deliberately left untouched by PR #595. Implements the approved spec for GROW-6121 (tracked internally, not committed to this repo).
Ticket: GROW-6121. Spec approved by the requester.
Changes
Four files under
warpdotdev/docs,src/content/docs/terminal/:warpify/ssh.mdx— rewrote the "Legacy: tmux-based Warpification" section as a short historical note stating the flow was removed (not "deprecated"/pending removal); trimmed the duplicated 11-item "What you get over SSH" feature list to a short summary that points tocode/ssh-feature-support.mdxup front; added one link to the legacy SSH wrapper in the Requirements section's fallback-conditions description.warpify/ssh-legacy.mdx— hidden from the primary Warpify sidebar nav while staying directly linkable/reachable. This repo's sidebar is manually curated viastarlight-sidebar-topics(src/sidebar.ts), not Starlight's native auto-generated sidebar, so Starlight'ssidebar: hiddenfrontmatter alone has no effect here (confirmed empirically — the pre-existinguniversal-input.mdxpage still appears in the sidebar despite carrying that same frontmatter). The page is removed fromsrc/sidebar.ts's items list and associated with theterminaltopic as an "unlisted page" via the plugin's owntopicfrontmatter field, which isstarlight-sidebar-topics's documented mechanism for this exact case.warpify/index.mdx— nested "SSH Legacy" under "SSH" as a single fallback clause instead of a third co-equal numbered item.terminal/settings/all-settings.mdx— rewordedenable_legacy_ssh_wrapperanduse_ssh_tmux_wrapperto state plainly that they have no effect on current behavior and are retained only for a one-time migration, rather than just "Deprecated in favor of X."All five IA decisions were confirmed with the requester via a structured alignment round; see the GROW-6121 Linear ticket for full product/tech detail and design alternatives.
Verification
Content-only change to static docs pages — no user-facing app UI, so no
computer_usestep applies (perfactory-verification); verified via the repo's documented checks:npm run build— passes (Astro build catches broken frontmatter, links, and MDX syntax errors).npm run typecheck(astro check) — 0 errors, 0 warnings (same pre-existing hints as main, none introduced).python3 .agents/skills/check_for_broken_links/check_links.py --internal-only— 0 broken links across 379 files / 3925 internal links, including the newssh.mdx→ssh-legacy.mdxandwarpify/index.mdx→ssh-legacy.mdxlinks.python3 .agents/skills/style_lint/style_lint.py --all— identical issue count/content on the four touched files before and after this change (0 new issues).python3 .agents/skills/validate_ui_refs/validate_ui_refs.py --check-paths --check-commands --check-format --warp ../warp— identical result before/after (0 new issues; the one pre-existing unmatched-command finding invim.mdxis unrelated to this change).npm run dev:/terminal/warpify/ssh-legacy/returns 200 and renders its title/content directly;/terminal/warpify/ssh/'s rendered sidebar no longer lists "Legacy SSH wrapper".code/ssh-feature-support.mdxuntouched; exactly one new link to/terminal/warpify/ssh-legacy/added (inssh.mdx's Requirements section) — the link inwarpify/index.mdxalready existed pre-change, just repositioned;all-settings.mdxchanges are description-text-only (no type/default/toml_path changes).Rework changes
warpify/ssh-legacy.mdxcarried asidebar:\n hidden: truefrontmatter block that had no effect in this repo (the sidebar is manually curated viastarlight-sidebar-topics, which ignores Starlight's nativesidebar.hiddenfield). Dropped it, keeping only thetopic: terminalfield, which is the field that actually keeps the page out of the primary Warpify nav. Re-verified withnpm run build,npm run typecheck, the broken-links checker, andstyle_lint— all clean, no new issues. The page still returns 200 at/terminal/warpify/ssh-legacy/and remains absent fromssh.mdx's rendered sidebar..agents/specs/GROW-6121-ssh-warpify-ia-reframe.mdfrom this PR; the reviewed/approved doc content changes are unaffected. Re-verifiednpm run buildpasses with the file gone (it lived outside the Astro content collection, so this has no rendering impact). Full spec content remains available on the GROW-6121 Linear ticket/thread.Originating thread: https://warpdev.slack.com/archives/C09BVK0PL3Y/p1787862877099789