Skip to content

docs: deprecate REPL/interactive shell references, redirect to Copilot CLI#938

Merged
bradygaster merged 4 commits intobradygaster:devfrom
diberry:squad/docs-deprecate-repl-references
Apr 11, 2026
Merged

docs: deprecate REPL/interactive shell references, redirect to Copilot CLI#938
bradygaster merged 4 commits intobradygaster:devfrom
diberry:squad/docs-deprecate-repl-references

Conversation

@diberry
Copy link
Copy Markdown
Collaborator

@diberry diberry commented Apr 9, 2026

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

  • README.md — \squad shell\ marked deprecated in commands table + deprecation banner on Interactive Shell section
  • README.zh.md — Chinese mirror of the same (已弃用)
  • docs/get-started/choose-your-interface.md — Deprecation warning + feature matrix updated with Interactive Shell column
  • docs/reference/cli.md — \squad\ (no args) and \squad shell\ marked deprecated
  • docs/guide.md — \squad shell\ references marked deprecated
  • blog/015-wave-2-the-repl-moment.md — Archive note added

Not deprecated (still valid)

  • \squad start --tunnel\ / \squad rc\ (Remote Control)
  • \squad watch\ / \squad triage\ (Ralph monitoring)
  • \squad loop\ (continuous work loop)

Review process

  • PAO audited and made initial edits
  • Flight (Lead) reviewed → rejected with 2 findings (broken link, missing guide.md)
  • EECOM fixed both findings (per reviewer rejection protocol — different agent)
  • FIDO (Quality) passed all 7 quality checks

Copilot AI added 2 commits April 8, 2026 17:51
…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>
Copilot AI review requested due to automatic review settings April 9, 2026 01:21
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 shell and 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 uses gh copilot. That conflicts with the PR goal (“all docs now point users to copilot --agent squad as the primary interface”) and may confuse readers. Consider updating the example to use copilot --agent squad (or explicitly note that gh copilot is 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>

Comment thread docs/src/content/docs/reference/cli.md Outdated
Comment thread docs/src/content/docs/get-started/choose-your-interface.md
Comment thread docs/src/content/blog/015-wave-2-the-repl-moment.md
diberry and others added 2 commits April 8, 2026 18:50
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>
Copy link
Copy Markdown
Collaborator Author

@diberry diberry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

�� 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.

@bradygaster
Copy link
Copy Markdown
Owner

thank you @diberry !!!!!! this will help immensely.

@bradygaster bradygaster merged commit 768b7af into bradygaster:dev Apr 11, 2026
tamirdresher pushed a commit that referenced this pull request Apr 21, 2026
…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>
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.

4 participants