Skip to content

Homepage design #818

@hey-august

Description

@hey-august

Docs content map

1. REST APIs (/apis)

The auto-generated API reference. Covers 11 service areas:

  • Calling — Call control, SIP, addresses
  • Voice — Voice-specific operations
  • Message — SMS/MMS
  • Fax — Fax send/receive
  • Chat — Chat messaging
  • Video — Video rooms & conferencing
  • Fabric — Call Fabric resources
  • Space — Space management
  • Project — Project/account management
  • Datasphere — Document/vector storage (for AI)
  • Pubsub — Pub/sub messaging
  • Logs — Log retrieval

Plus a Core section (auth, base URL, error codes, paging, permissions).

2. SWML (/swml)

SignalWire Markup Language — YAML/JSON for building call flows.

  • Reference tab: Core intro, expressions, variables, schema, and a methods/ folder (answer, connect, ai, play, record,
    etc.)
  • Guides tab: Quickstart, basics, recipes, SWAIG functions

3. Agents SDK (/agents-sdk)

Python SDK for building AI voice agents.

  • Guides tab: Getting started, core concepts, building agents, SWAIG functions, skills, prefab agents, deployment,
    advanced topics, SignalWire integration, examples
  • Reference tab: API reference (AgentBase, SWMLService, SWAIG Function, DataMap, etc.), CLI tools (swaig-test,
    sw-search, sw-agent-init), configuration, appendix (best practices, patterns, troubleshooting, changelog, migration)

4. Server SDK (/server-sdk)

WebSocket-based realtime SDK (Node.js). Has version tabs (v4 current, v3/v2 deprecated).

  • Reference tab: Core, Voice, Video, Messaging (hidden), PubSub, Chat, Task
  • Guides tab: Core, Voice, Messaging (hidden)

5. Browser SDK (/browser-sdk)

Client-side WebRTC SDK (JavaScript). Has version tabs (v3 current, v2 deprecated).

  • Reference tab: Core, SignalWire Client, Video, Chat, PubSub, WebRTC
  • Guides tab: Core, Video, Chat
  • Click-to-Call tab: Dedicated tutorial section

6. Platform (/platform)

Dashboard, config, and product guides. Has 5 tabs:

  • Platform tab: Getting started, setup, core, architecture (Call Fabric), phone numbers, integrations
  • Calling tab: Overview, voice, video, fax
  • AI tab: Overview, getting started, guides
  • Messaging tab: SMS/MMS, chat
  • Tools tab: Folder of tools (Wirestarter, SWSH, etc.)

7. Compatibility API (/compatibility-api)

TwiML migration path. Has 3 tabs:

  • cXML tab: Core, guides, voice, messaging, fax (XML verb reference)
  • SDKs tab: Core, REST client methods
  • REST API tab: Auto-generated from OpenAPI spec

8. Call Flow Builder (/call-flow-builder)

Visual drag-and-drop call flow editor.

  • Core docs + Nodes reference

9. Tools (no dedicated Fern product — linked into Platform)

  • Wirestarter → /platform/tools/wirestarter
  • SWSH → /platform/tools/swsh

Missing elements

The current welcome.mdx homepage draft has these gaps:

Area Current state Issue
Products grid 5 generic cards
SWML Has a card Could use more detail, a graphic, etc.
Agents SDK Listed under SDKs Deserves more prominence since it's the primary AI developer entry point
Platform Not linked at all Not linked
Compatibility API Not linked at all Important for users migrating from Twilio/TwiML
Call Flow Builder Not linked at all Probably deserves a homepage mention
Tools Not linked at all Wirestarter, SWSH
Guides / Getting started No guide entry points Entry point should be the "Get Started" doc (https://signalwire.com/docs/platform/getting-started)
AI Only in generic product grid Should be a primary CTA given its importance

Suggested homepage sections

This is just my opinion

  1. Hero
  2. Primary CTAs (2-3 cards, prominent) — The main developer entry points:
  • AI Agents → /agents-sdk — "Build AI voice agents with Python"
  • SWML → /swml — "Build call flows with YAML/JSON"
  • SignalWire REST APIs → /apis — "Complete API reference"
  1. Products by capability
  • Voice → /platform/calling
  • Messaging → /platform/messaging
  • Video → /platform/calling (video tab)
  • Fax → /platform/calling (fax tab)
  • AI → /platform/ai
  • Chat → /platform/messaging (chat tab)
  1. SDKs & Tools (grid):
  • Server SDK → /server-sdk — Node.js realtime SDK
  • Browser SDK → /browser-sdk — Client-side WebRTC
  • Agents SDK → /agents-sdk — Python AI agents
  • Call Flow Builder → /call-flow-builder — Visual editor
  • Compatibility API → /compatibility-api — TwiML migration
  1. Platform & Setup — Getting started path:
  • Get started → /platform/getting-started
  • Call Fabric architecture → /platform/platform/call-fabric
  • Phone numbers → /platform/platform/phone-numbers
  • Dashboard tools → Wirestarter, SWSH
  1. Help & Support — Already exists, keep it.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions