Skip to content

docs: add CALM Copilot Chatmode and Voice Mode documentation#1809

Merged
rocketstack-matt merged 4 commits intofinos:mainfrom
gkaria:docupdates
Nov 18, 2025
Merged

docs: add CALM Copilot Chatmode and Voice Mode documentation#1809
rocketstack-matt merged 4 commits intofinos:mainfrom
gkaria:docupdates

Conversation

@gkaria
Copy link
Contributor

@gkaria gkaria commented Nov 17, 2025

Description

This PR adds comprehensive documentation for CALM Copilot Chat Voice Mode features, addressing issue #1755.

While implementing Voice Mode documentation, we identified that CALM Copilot Chatmode documentation was also missing from the docs site (only existed in CLI README). This PR adds both to provide complete coverage of AI-powered features in CALM.

Changes

New Documentation Files

  • docs/docs/working-with-calm/copilot-chatmode.md - Complete guide for setting up and using CALM Copilot Chatmode with GitHub Copilot Chat
  • docs/docs/working-with-calm/voice-mode.md - Comprehensive Voice Mode documentation covering speech-to-text and text-to-speech features

Updated Files

  • docs/docs/working-with-calm/index.md - Added links to new Copilot Chatmode and Voice Mode documentation
  • docs/docs/working-with-calm/using-the-cli.md - Added copilot-chatmode command reference and AI-Powered Development section

Documentation Coverage

CALM Copilot Chatmode Documentation Includes:

  • Prerequisites and installation requirements
  • Setup instructions with command examples
  • Overview of specialized tools (architecture, nodes, relationships, interfaces, controls, flows, patterns, metadata, documentation)
  • Usage examples and best practices
  • Comprehensive troubleshooting section
  • Configuration management

Voice Mode Documentation Includes:

  • Overview and prerequisites (VS Code 1.94+, GitHub Copilot Chat, VS Code Speech extension)
  • VS Code Speech extension installation (GUI and CLI methods)
  • Platform-specific microphone permission setup (Windows, macOS, Linux)
  • Three voice input activation methods:
    • Microphone icon
    • Hold-to-Speak mode
    • "Hey Code" voice activation
  • Text-to-speech configuration with VS Code settings
  • Auto-submit configuration
  • Best practices for transcription accuracy and efficient workflow
  • Comprehensive troubleshooting (microphone detection, transcription accuracy, latency, TTS issues)
  • Accessibility features (screen reader compatibility, voice-only workflow)
  • Platform-specific requirements and limitations
  • Complete VS Code settings reference with recommended configuration
  • Testing procedures

Key Features Documented

✅ Speech-to-text voice input for CALM architecture queries
✅ Text-to-speech for chat responses
✅ Auto-submit configuration
✅ "Hey Code" hands-free voice activation
✅ Hold-to-Speak mode for rapid queries
✅ Platform-specific setup instructions (Windows, macOS, Linux)
✅ Accessibility considerations
✅ Local processing (no internet required for voice features)
✅ Complete troubleshooting guides
✅ Real-world usage examples and workflows

Testing

Documentation has been validated with:

  • VS Code 1.106 on macOS
  • GitHub Copilot Chat with CALM chatmode
  • VS Code Speech extension
  • Real-world testing of voice input, auto-submit, and text-to-speech features
  • Platform-specific permission setup verification
  • Settings configuration validation

Documentation Preview

Once published, documentation will be available at:

Checklist

  • Documentation follows existing style and format
  • All links are working and properly formatted
  • Code examples are accurate and tested
  • Platform-specific instructions provided (Windows, macOS, Linux)
  • Troubleshooting sections are comprehensive
  • Settings examples are valid JSON
  • Markdown frontmatter is properly formatted
  • Sidebar positions are correctly assigned

Resolves

Closes #1755

Add comprehensive documentation for CALM Copilot Chatmode and Voice Mode
features to address GitHub issue finos#1755.

Changes:
- Add copilot-chatmode.md: Complete guide for setting up AI-powered
  development assistance with GitHub Copilot Chat, including setup,
  usage, specialized tools, and troubleshooting
- Add voice-mode.md: Comprehensive guide for hands-free interaction
  using VS Code Speech extension, covering installation, microphone
  setup, usage, best practices, accessibility, and platform-specific
  instructions for Windows/macOS/Linux
- Update index.md: Add links to new Copilot Chatmode and Voice Mode docs
- Update using-the-cli.md: Add copilot-chatmode command reference and
  AI-Powered Development section

Resolves: finos#1755
@gkaria gkaria requested a review from a team as a code owner November 17, 2025 22:19
@github-actions github-actions bot added the docs label Nov 17, 2025
Copy link
Member

@rocketstack-matt rocketstack-matt left a comment

Choose a reason for hiding this comment

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

I think there are still options to reduce some of the verbiage

@rocketstack-matt rocketstack-matt merged commit 14853bb into finos:main Nov 18, 2025
11 of 12 checks passed
pmerrison pushed a commit to pmerrison/architecture-as-code that referenced this pull request Nov 20, 2025
docs: add CALM Copilot Chatmode and Voice Mode documentation
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.

CALM Copilot Chat - Voice Mode

2 participants