Add dev docs category overviews

packages/js/src/Modules/Verto/BaseSession.ts

@@ -193,7 +193,7 @@ export default abstract class BaseSession {
   /**
    * Attaches an event handler for a specific type of event.
    *
-   * ## Events
+   * ### Events
    * |   |   |
    * |---|---|
    * | `telnyx.ready` | The client is authenticated and available to use |

packages/js/src/Modules/Verto/webrtc/Call.ts

@@ -4,6 +4,50 @@ import { CallOptions } from './interfaces';
 import { getDisplayMedia, setMediaElementSinkId } from '../util/webrtc';
 
 /**
+ * A `Call` is the representation of an audio or video call between
+ * two browsers, SIP clients or phone numbers. The `call` object is
+ * created whenever a new call is initiated, either by you or the
+ * remote caller. You can access and act upon calls initiated by
+ * a remote caller in a `telnyx.notification` event handler.
+ *
+ * @examples
+ *
+ * To create a new call, i.e. dial:
+ *
+ * ```js
+ * const call = client.newCall({
+ *   // Destination is required and can be a phone number or SIP URI
+ *   destinationNumber: '18004377950',
+ *   callerNumber: '‬155531234567',
+ * });
+ * ```
+ *
+ * To answer an incoming call:
+ *
+ * ```js
+ * client.on('telnyx.notification', (notification) => {
+ *   const call = notification.call;
+ *
+ *   if (notification.type === 'callUpdate' && call.state === 'ringing') {
+ *     call.answer();
+ *   }
+ * });
+ * ```
+ *
+ * Both the outgoing and incoming call has methods that can be hooked up to your UI.
+ *
+ * ```js
+ * // Hangup or reject an incoming call
+ * call.hangup();
+ *
+ * // Send digits and keypresses
+ * call.dtmf('1234');
+ *
+ * // Call states that can be toggled
+ * call.hold();
+ * call.muteAudio();
+ * ```
+ *
  * @category Call
  */
 export default class Call extends BaseCall {

packages/js/src/TelnyxRTC.ts

@@ -2,6 +2,35 @@ import TelnyxRTCClient from './Modules/Verto';
 import { ITelnyxRTCOptions } from './Modules/Verto/util/interfaces';
 
 /**
+ * The `TelnyxRTC` client connects your application to the Telnyx backend,
+ * enabling you to make outgoing calls and handle incoming calls.
+ *
+ * @examples
+ *
+ * ```js
+ * // Initialize the client
+ * const client = new TelnyxRTC({
+ *   // Use a JWT to authenticate (recommended)
+ *   login_token: login_token,
+ *   // or use your Connection credentials
+ *   //  login: username,
+ *   //  password: password,
+ * });
+ *
+ * // Attach event listeners
+ * client
+ *   .on('telnyx.ready', () => console.log('ready to call'))
+ *   .on('telnyx.notification', (notification) => {
+ *     console.log('notification:', notification)
+ *   });
+ *
+ * // Connect and login
+ * client.connect();
+ *
+ * // You can disconnect when you're done
+ * //  client.disconnect();
+ * ```
+ *
  * @category Client
  */
 export default class TelnyxRTC extends TelnyxRTCClient {