Skip to content

Publish a canonical terminology registry and glossary #561

Description

@hey-august

The docs use Server SDKs, Server SDK, Agents SDK, Realtime SDK, RELAY, and Relay Applications interchangeably. The getting-started page presents the Agents SDK and Realtime SDK as separate choices even though both lead to the unified Server SDKs product, and the homepage metadata still says "Realtime SDKs". Humans infer the history; a model may conclude these are separate packages.

Add an authoritative alias registry (canonical name, aliases, historical names, canonical URL) and a glossary with one canonical definition per major entity — Space, Project, API token vs subscriber token, Resource vs Address, call leg, SWML document, SWAIG function, RELAY session, the three meanings of "AI Agent" — each with aliases, "not the same as" entries, relationships, and a canonical page. Pages using an alias should state the relationship on first use ("The Realtime SDK is the RELAY namespace of the unified Server SDK"). Same treatment for LaML → cXML. Audit §3 and §10.

Aliases are defined once here; the decision manifest (#562) references this registry rather than redefining them.

Metadata

Metadata

Assignees

No one assigned

    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