Skip to content

Rewrite: Resource page #371

@Manny-r31

Description

@Manny-r31

Current state

  • Source file: /signalwire-fern-config/fern/products/platform/pages/platform/call-fabric/resources.mdx
  • Live URL: https://signalwire.com/docs/platform/resources
  • Page type (Fern): overview

What's there today

  • One-sentence intro claiming "Resources are the primary entities for communication" but leaves the concept undefined: what is a Resource concretely?
  • Two subsections under "Manage Resources": REST API (single Card link) and Dashboard instructions for create/modify/delete
  • Dashboard instructions using screenshots and Steps
  • "In the Legacy Dashboard" section (8 lines)

Reviewer's concern

"Needs a full rewrite."

Problems

  • Conceptual gap: The page defines what a Resource is but there should be more depth in the types of resources. We state that "Resources are the building blocks of SignalWire applications. They include AI Agents, SWML Scripts, cXML Scripts, SIP Endpoints, and more." I think these should be expanded upon a bit individually.

"Resources are container objects that hold communication capabilities, identified by addresses. Subscribers are a specific type of Resource."

  • Inverted relationship: Opening sentence says Resources "interact with subscribers," but from the Subscribers page it's clear Subscribers ARE Resources, so we should make it more obvious that this is just the primary type of resource.

  • Disproportionate legacy content: "In the Legacy Dashboard" section wastes real estate explaining a deprecated UI; should be removed.

  • Thin API coverage: Only a single Card linking to REST endpoints; no explanation of Resource lifecycle or REST operations beyond "use endpoints."

  • No addressing explanation: Doesn't link to or explain Resource Addresses (the /context/name system shared across all Resources), which is critical to understanding how Resources are identified and targeted.

  • Missing integration examples: No code examples or common patterns (e.g., "create a Subscriber Resource," "assign a phone number to a resource," "map an AI Agent to an address").

Proposed rewrite

  • What are Resources
    Define Resources as container objects that represent communication entities in Call Fabric. Explain that every Resource has an Address (/context/name) and a Type. Briefly list the main types (Subscribers, AI Agents, SWML Scripts, Video Rooms). Establish that Subscribers are the primary Resource type for user management. Present Resources as the unifying abstraction across all communication entities.

  • Resource types
    Quick overview of each major type: what it is, primary use case. Link to dedicated pages (Subscribers, AI Agents guide, etc.). Make clear that all types use the same addressing and management patterns.

  • Resource addresses
    Explain the Address system (context + name), contexts (public/private), and mutability. Cite the Addresses guide. This bridges to how Resources are identified and called.

  • Manage Resources
    Two subsections: Via REST API (explain lifecycle: create, retrieve, update, list, delete; link to REST endpoints) and Via Dashboard (create/view/edit/delete;)

  • Next steps
    Direct readers to Subscribers page, Addresses page, and REST API docs.

Metadata

Metadata

Assignees

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