Skip to content

SUPPORT.md

Latest commit

 

History

History
49 lines (35 loc) · 2.53 KB

SUPPORT.md

File metadata and controls

49 lines (35 loc) · 2.53 KB
Raw

Support

Thanks for trying vocaphone. Use this guide to get help without opening the wrong kind of issue.

Before you ask

  1. Confirm you are on the latest main commit (or a released build, when those exist).
  2. Read docs/troubleshooting.md for common setup and runtime failures.
  3. Check docs/device-setup.md for iOS keyboard / Android bubble setup.
  4. Check docs/deployment.md (and the vocagateway guides it links) for gateway, Docker, Tailscale, and HTTPS setup.
  5. Search existing issues for the same problem. Gateway-only bugs often belong on vocagateway issues.

Where to get help

Topic Where
Chat with maintainers and other contributors Discord
Setup, usage, or "how do I…?" questions GitHub Discussions (when enabled) or a clearly titled issue using the question/feature templates
Reproducible bugs Bug report
Feature ideas Feature request
Security or privacy vulnerabilities SECURITY.md — never a public issue
Contributing code or docs CONTRIBUTING.md
Community standards CODE_OF_CONDUCT.md

What to include

When you ask for help, include:

  • Component: iOS app, keyboard, Android bubble, native gateway, or Docker gateway
  • Exact versions: OS, Xcode/Android SDK/Python as relevant, the vocaphone git commit or release, and the gateway submodule SHA when the gateway is involved
  • What you expected vs what happened
  • Redacted steps to reproduce
  • Redacted logs (see below)

Do not include

Never paste:

  • Microphone recordings or transcripts
  • Bearer tokens, .env values, or signing material
  • Private Tailscale hostnames or internal URLs that identify your network
  • Apple provisioning profiles or keystore files
  • Screenshots that show personal messages, contacts, or credentials

Replace secrets with placeholders such as <token>, <tailnet-host>, or <user-id>.

Maintainer contact

For private security reports or conduct concerns, email hello@vocahq.com. For everything else, prefer GitHub so other contributors can help and the answer stays searchable.