docs: deprecate REPL/interactive shell references, redirect to Copilot CLI#938
Conversation
…t CLI Mark \squad shell\ and no-args interactive shell as deprecated across README.md, README.zh.md, CLI reference, getting-started guide, and blog archive. All docs now point users to GitHub Copilot CLI as the primary interface. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Fix broken /guide/choose-your-interface/ link in blog archive note (correct path: /docs/get-started/choose-your-interface/). Add deprecation markers to guide.md for squad shell references. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Deprecates the legacy Squad interactive shell documentation (both squad with no args and squad shell) and redirects readers toward using GitHub Copilot CLI (copilot --agent squad) as the primary conversational interface.
Changes:
- Marks
squad shelland the no-args REPL as deprecated in READMEs and CLI/reference docs. - Adds deprecation callouts and updates the interface comparison matrix to include “Interactive shell” explicitly.
- Adds an archive note to the REPL blog post to redirect readers to the current recommended interface.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Deprecates squad shell and adds a deprecation banner for the Interactive Shell section. |
| README.zh.md | Chinese mirror of the same deprecation messaging and redirect to Copilot CLI. |
| docs/src/content/docs/reference/cli.md | Marks squad (no args) and squad shell as deprecated in the CLI reference table. |
| docs/src/content/docs/guide.md | Updates guide references to flag squad shell as deprecated. |
| docs/src/content/docs/get-started/choose-your-interface.md | Adds deprecation callout for interactive shell; updates feature matrix to include “Interactive shell”. |
| docs/src/content/blog/015-wave-2-the-repl-moment.md | Adds an archive note redirecting readers away from the deprecated REPL. |
Comments suppressed due to low confidence (1)
docs/src/content/docs/guide.md:34
- This guide now says the interactive shell is deprecated in favor of
copilot --agent squad, but the “Common workflow” example still usesgh copilot. That conflicts with the PR goal (“all docs now point users tocopilot --agent squadas the primary interface”) and may confuse readers. Consider updating the example to usecopilot --agent squad(or explicitly note thatgh copilotis an alternative invocation if both are supported).
- Initial setup: `squad init`
- Build from config: `squad build`
- Diagnostics: `squad doctor`
- Interactive shell: `squad shell` — **Deprecated** (use `copilot --agent squad`)
- Continuous triage: `squad triage --interval 10`
- Watch mode: `squad watch`
- Aspire dashboard: `squad aspire`
- Export/import: `squad export` and `squad import`
- Plugin management: `squad plugin install <name>`
**Common workflow:**
```bash
# Terminal 1: Run continuous triage (Squad CLI)
squad triage --interval 10
# Terminal 2: Work with your team (GitHub Copilot CLI)
gh copilot
> @squad what issues are ready to work?
</details>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
The reference to Interactive Shell Guide is removed as the shell is deprecated. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
diberry
left a comment
There was a problem hiding this comment.
�� Review Findings
🟠 P1: Fixed — Deprecated link removed
The reference to ../guide/shell.md\ in \choose-your-interface.md\ has been removed. Since the interactive shell is deprecated and users are being directed to GitHub Copilot CLI instead, removing the link to the shell guide aligns with the deprecation message.
✓ Status: Fixed and pushed to the PR branch.
🟡 P2: Link path inconsistency
README.md uses a different link format than the blog archive — consider standardizing to /docs/\ paths across all files for consistency.
🟡 P2: CLI.md table order
In CLI.md, the \squad shell\ entry appears after other commands, potentially breaking the logical grouping of core/foundational commands vs. utility commands. Consider reordering for better discoverability.
|
thank you @diberry !!!!!! this will help immensely. |
…t CLI (#938) * docs: deprecate REPL/interactive shell references, redirect to Copilot CLI Mark \squad shell\ and no-args interactive shell as deprecated across README.md, README.zh.md, CLI reference, getting-started guide, and blog archive. All docs now point users to GitHub Copilot CLI as the primary interface. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: fix review findings — broken blog link, guide.md deprecation Fix broken /guide/choose-your-interface/ link in blog archive note (correct path: /docs/get-started/choose-your-interface/). Add deprecation markers to guide.md for squad shell references. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix: remove deprecated link in choose-your-interface.md The reference to Interactive Shell Guide is removed as the shell is deprecated. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Mark squad shell and no-args interactive shell as deprecated across README.md, README.zh.md, CLI reference, getting-started guide, guide.md, and blog archive. All docs now point users to GitHub Copilot CLI (\copilot --agent squad) as the primary interface.
Changes
Not deprecated (still valid)
Review process