Skip to content

Rewrite: Platform Video #378

@Manny-r31

Description

@Manny-r31

Current state

  • Source file: /signalwire-fern-config/fern/products/platform/pages/calling/video/overview.mdx
  • Live URL: https://signalwire.com/docs/platform/video#frequently-asked-questions
  • Page type (Fern): overview

What's there today

  • A 3-sentence intro paragraph (lines 10–12) describing SignalWire Video's MCU architecture: "A single unified stream is sent to each participant, resulting in low latency, high quality, and the same video stream for all users."
  • A 3-card CardGroup linking to REST APIs, SDK Reference, and Browser SDKs (lines 14–36).
  • 16 frequently-asked-questions in an AccordionGroup (lines 39–117) covering room creation, naming constraints, permissions, token expiry, encryption, IP blocking, HIPAA compliance, chat integration, video filters, camera behavior, RTMP support, recording storage/deletion, participant definition, and Programmable Video Conference customization.

Reviewer's concern

"Own page, main index could use a rewrite as right now it is just a single paragraph."

Problems

  • Thin intro: The main index opens with a single 3-sentence paragraph followed immediately by a CardGroup. New users have no context for what Video capabilities exist, use cases, or architectural overview before being asked to choose an API pathway.
  • FAQ crowding overview: 16 accordion questions on the overview page create cognitive load and duplicate the purpose of a dedicated FAQ page. The accordion takes up lines 39–117, making the overview feel like a reference rather than an entry point.
  • No use-case framing: The intro does not explain when to choose Video vs. other SignalWire services or what problems it solves. Contrast with the Voice overview, which opens with "Whether building a UCaaS solution, modernizing a legacy IVR, augmenting CX with AI, or migrating from another provider's APIs..."
  • Missing concepts: No mention of what Programmable Video Conferences (referenced in accordion Remove leftover readme and .DS_STORE #16–17) are, no distinction between REST API (room management) and Browser SDK (participant UX), no mention of key features like recording, room previews, or screen sharing before deep-linking to them.

Proposed rewrite

  • Overview page (/video) — rewrite intro to cover:

    • The MCU architecture with an explanation on why it matters (low latency, unified experience).
    • Introduce the ways to use Video specifically
    • Highlight key features: recording (enabled manually), screen sharing, moderator/guest controls, HIPAA compliance.
    • Preserve CardGroup;
    • Remove the 16-item accordion entirely, and link to the newly create faq page where they now sit via next steps section.
  • New dedicated FAQ page (/video/faqs) containing:

    • All 16 accordion items extracted from overview (lines 43–115) and new front matter
    • Add redirect if necessary

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions