[Matrix] Phase 3: Documentation

[alacy-centrl]

Overview

Update documentation to include Matrix channel support in README and user guides.

Tasks

• Update packages/opencode-router/README.md
• Add Matrix section with setup instructions
• Add Matrix CLI command examples
• Update configuration examples
• Add troubleshooting section
• Create Matrix-specific FAQ
• Add to main OpenWork documentation

Documentation Sections

README Updates

• Matrix overview and features
• Prerequisites (Matrix account, homeserver)
• Configuration steps
• CLI commands reference
• Example usage scenarios

Configuration Examples

{
  "version": 1,
  "channels": {
    "matrix": {
      "enabled": true,
      "accounts": [
        {
          "id": "default",
          "homeserverUrl": "https://matrix.org",
          "accessToken": "syt_...",
          "enabled": true
        }
      ]
    }
  }
}

CLI Examples

# Add Matrix identity
opencode-router matrix add https://matrix.org syt_abc123 --id default

# List identities
opencode-router matrix list

# Send message
opencode-router send --channel matrix --identity default --to '!room:matrix.org' --message 'Hello'

# Set binding
opencode-router bindings set --channel matrix --identity default --peer '!room:matrix.org' --dir /workspace

Acceptance Criteria

• Documentation is clear and comprehensive
• Examples work as documented
• No broken links or references
• Covers common use cases
• Includes troubleshooting for common issues

Estimated Time

1 day

Dependencies

• All previous phases complete

Technical Details

• Follow existing README structure
• Add badges for Matrix support
• Include screenshots if helpful
• Link to Matrix.org resources

See full plan: https://github.com/users/alacy-centrl/projects/2

[alacy-centrl]

I apologize for opening these issues in the wrong repository. These Matrix integration issues should have been created in my personal fork. I'm closing this issue and moving it to alacy-centrl#10

Sorry for the confusion!