Skip to content

docs(cli): document current socket mode commands - #3084

Merged
teddy arida-moody (teddyam) merged 3 commits into
mainfrom
teddyam-socket-mode-command-docs
Nov 19, 2026
Merged

teddy arida-moody (teddyam) merged 3 commits into
mainfrom
teddyam-socket-mode-command-docs

Conversation

@teddyam

Copy link
Copy Markdown
Collaborator

Summary

Update the CLI documentation to describe the socket-mode behavior currently merged into main, so users can choose and troubleshoot message delivery without relying on testing-era instructions.

  • Expand app create, app update, app get, and app doctor references with socket/HTTP workflows, Azure examples, JSON follow-up fields, and restart guidance.
  • Explain that failed socket-mode enablement leaves the created bot in HTTP mode and requires a public HTTPS endpoint for HTTP delivery, or a retry to enable sockets.
  • Update the quickstart, command overview, bot-location guidance, and tunnel documentation to distinguish HTTP endpoint requirements from socket delivery.
  • Keep the documentation focused on current behavior, without intermediate testing flags or migration history.

Documentation only; no CLI behavior changes.

Validation

  • npx turbo build --filter=@microsoft/teams.cli
  • Compared documented options against built CLI JSON help.
  • Checked relative Markdown links and anchors; preserved autogenerated command-reference blocks.
  • git diff --check

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings November 13, 2026 18:22

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues remain for the documentation-only clarification of socket and HTTP delivery workflows.

No open issues 🎉

What changed in this PR

Updates CLI documentation to explain current socket-mode behavior alongside HTTP delivery. Documentation only; no CLI behavior changes.

Changes:

  • Add socket/HTTP workflows for creation, updates, inspection, and diagnostics.
  • Document socket enablement failures, recovery steps, JSON follow-up fields, and restart requirements.
  • Clarify when public HTTPS endpoints and tunnels are needed across bot locations.
File Description
teams.md/​docs/​main/​developer-tools/​local-tunnels.md Distinguishes HTTP tunnels from socket delivery.
teams.md/​docs/​cli/​index.md Adds messaging modes to the CLI feature overview.
teams.md/​docs/​cli/​getting-started/​quickstart.md Adds socket and HTTP creation examples.
teams.md/​docs/​cli/​concepts/​local-tunnels.md Explains switching from sockets to tunnel-based HTTP.
teams.md/​docs/​cli/​concepts/​bot-locations.md Clarifies that messaging mode is independent of bot location.
teams.md/​docs/​cli/​commands/​index.md Adds a messaging-mode command reference table.
teams.md/​docs/​cli/​commands/​app/​update.md Documents mode switching, endpoint requirements, and JSON follow-ups.
teams.md/​docs/​cli/​commands/​app/​get.md Explains configured-mode inspection and its limits.
teams.md/​docs/​cli/​commands/​app/​doctor.md Describes socket diagnostics and endpoint probing.
teams.md/​docs/​cli/​commands/​app/​create.md Adds Azure examples, ownership requirements, and failure recovery.

Review effort: Balanced

Comment thread teams.md/docs/cli/index.md Resolved
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot AI balanced review requested due to automatic review settings November 19, 2026 15:38

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues are reported for the documentation update clarifying socket-mode and HTTP delivery.

No open issues 🎉

Review effort: Balanced

Copilot AI balanced review requested due to automatic review settings November 19, 2026 18:50

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

No active review issues were identified in the documentation update covering socket-mode setup, diagnostics, and HTTP delivery differences.

No open issues 🎉

Review effort: Balanced

@teddyam
teddy arida-moody (teddyam) merged commit e947b57 into main Nov 19, 2026
15 checks passed
@teddyam
teddy arida-moody (teddyam) deleted the teddyam-socket-mode-command-docs branch November 19, 2026 19:18
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.

3 participants