update documentation

Author: josephlim94

docs/index.md

@@ -13,6 +13,7 @@ Easily send and share WebRTC media through [Janus](https://github.com/meetecho/j
     - EchoTest Plugin
     - VideoCall Plugin
     - VideoRoom Plugin
+    - TextRoom Plugin
 - Extendable Transport class and Plugin class
 
 ## Library Installation

docs/plugins.md

@@ -4,32 +4,21 @@ Janus plugins provide specific functionality for different use cases. This libra
 
 Plugins are the core components that implement specific WebRTC functionality. Each plugin corresponds to a server-side Janus plugin and provides a Python interface for interacting with it.
 
-## Base Plugin Class
+For detailed API documentation, see the [API Reference](reference.md#plugin-classes).
 
-All plugins inherit from the base `JanusPlugin` class, which provides common functionality for plugin lifecycle management, message handling, and WebRTC signaling.
+## Overview
 
-::: janus_client.plugin_base.JanusPlugin
-    options:
-      show_root_heading: true
-      show_source: false
-      members_order: source
-      docstring_section_style: table
-      separate_signature: true
-      show_signature_annotations: true
+All plugins inherit from the base `JanusPlugin` class, which provides common functionality for plugin lifecycle management, message handling, and WebRTC signaling. The library includes support for:
+
+- **EchoTest Plugin** - Testing WebRTC connectivity
+- **VideoCall Plugin** - One-to-one video calls
+- **VideoRoom Plugin** - Multi-party video conferencing
+- **TextRoom Plugin** - Text-based communication via DataChannels
 
 ## EchoTest Plugin
 
 The EchoTest plugin is useful for testing WebRTC connectivity. It echoes back any media sent to it, making it perfect for testing your setup.
 
-::: janus_client.plugin_echotest.JanusEchoTestPlugin
-    options:
-      show_root_heading: true
-      show_source: false
-      members_order: source
-      docstring_section_style: table
-      separate_signature: true
-      show_signature_annotations: true
-
 ### EchoTest Usage Example
 
 ```python
@@ -61,15 +50,6 @@ if __name__ == "__main__":
 
 The VideoCall plugin enables one-to-one video calls between users. It handles user registration, call initiation, and call management.
 
-::: janus_client.plugin_video_call.JanusVideoCallPlugin
-    options:
-      show_root_heading: true
-      show_source: false
-      members_order: source
-      docstring_section_style: table
-      separate_signature: true
-      show_signature_annotations: true
-
 ### VideoCall Usage Example
 
 ```python
@@ -107,31 +87,6 @@ if __name__ == "__main__":
 
 The VideoRoom plugin enables multi-party video conferencing. It supports room management, publishing, and subscribing to multiple video feeds.
 
-::: janus_client.plugin_video_room.JanusVideoRoomPlugin
-    options:
-      show_root_heading: true
-      show_source: false
-      members_order: source
-      docstring_section_style: table
-      separate_signature: true
-      show_signature_annotations: true
-
-### VideoRoom State Class
-
-::: janus_client.plugin_video_room.JanusVideoRoomPlugin.State
-    options:
-      show_root_heading: true
-      show_source: false
-      docstring_section_style: table
-
-### AllowedAction Enum
-
-::: janus_client.plugin_video_room.AllowedAction
-    options:
-      show_root_heading: true
-      show_source: false
-      docstring_section_style: table
-
 ### VideoRoom Usage Example
 
 ```python
@@ -172,31 +127,6 @@ if __name__ == "__main__":
 
 The TextRoom plugin enables text-based communication through WebRTC DataChannels. It supports multiple rooms, public and private messaging, room management, and message history.
 
-::: janus_client.plugin_textroom.JanusTextRoomPlugin
-    options:
-      show_root_heading: true
-      show_source: false
-      members_order: source
-      docstring_section_style: table
-      separate_signature: true
-      show_signature_annotations: true
-
-### TextRoomError Exception
-
-::: janus_client.plugin_textroom.TextRoomError
-    options:
-      show_root_heading: true
-      show_source: false
-      docstring_section_style: table
-
-### TextRoomEventType Enum
-
-::: janus_client.plugin_textroom.TextRoomEventType
-    options:
-      show_root_heading: true
-      show_source: false
-      docstring_section_style: table
-
 ### TextRoom Usage Examples
 
 #### Basic Room Communication

docs/reference.md

@@ -0,0 +1,148 @@
+# API Reference
+
+Complete API reference for all classes, methods, and types in the Python Janus Client library.
+
+## Session Classes
+
+### JanusSession
+
+::: janus_client.session.JanusSession
+    options:
+      show_root_heading: true
+      show_source: false
+      members_order: source
+      docstring_section_style: table
+      separate_signature: true
+      show_signature_annotations: true
+
+### PluginAttachFail Exception
+
+::: janus_client.session.PluginAttachFail
+    options:
+      show_root_heading: true
+      show_source: false
+      docstring_section_style: table
+
+## Plugin Classes
+
+### Base Plugin Class
+
+::: janus_client.plugin_base.JanusPlugin
+    options:
+      show_root_heading: true
+      show_source: false
+      members_order: source
+      docstring_section_style: table
+      separate_signature: true
+      show_signature_annotations: true
+
+### EchoTest Plugin
+
+::: janus_client.plugin_echotest.JanusEchoTestPlugin
+    options:
+      show_root_heading: true
+      show_source: false
+      members_order: source
+      docstring_section_style: table
+      separate_signature: true
+      show_signature_annotations: true
+
+### VideoCall Plugin
+
+::: janus_client.plugin_video_call.JanusVideoCallPlugin
+    options:
+      show_root_heading: true
+      show_source: false
+      members_order: source
+      docstring_section_style: table
+      separate_signature: true
+      show_signature_annotations: true
+
+### VideoRoom Plugin
+
+::: janus_client.plugin_video_room.JanusVideoRoomPlugin
+    options:
+      show_root_heading: true
+      show_source: false
+      members_order: source
+      docstring_section_style: table
+      separate_signature: true
+      show_signature_annotations: true
+
+#### VideoRoom State Class
+
+::: janus_client.plugin_video_room.JanusVideoRoomPlugin.State
+    options:
+      show_root_heading: true
+      show_source: false
+      docstring_section_style: table
+
+#### AllowedAction Enum
+
+::: janus_client.plugin_video_room.AllowedAction
+    options:
+      show_root_heading: true
+      show_source: false
+      docstring_section_style: table
+
+### TextRoom Plugin
+
+::: janus_client.plugin_textroom.JanusTextRoomPlugin
+    options:
+      show_root_heading: true
+      show_source: false
+      members_order: source
+      docstring_section_style: table
+      separate_signature: true
+      show_signature_annotations: true
+
+#### TextRoomError Exception
+
+::: janus_client.plugin_textroom.TextRoomError
+    options:
+      show_root_heading: true
+      show_source: false
+      docstring_section_style: table
+
+#### TextRoomEventType Enum
+
+::: janus_client.plugin_textroom.TextRoomEventType
+    options:
+      show_root_heading: true
+      show_source: false
+      docstring_section_style: table
+
+## Transport Classes
+
+### Base Transport Class
+
+::: janus_client.transport.JanusTransport
+    options:
+      show_root_heading: true
+      show_source: false
+      members_order: source
+      docstring_section_style: table
+      separate_signature: true
+      show_signature_annotations: true
+
+### HTTP Transport
+
+::: janus_client.transport_http.JanusTransportHTTP
+    options:
+      show_root_heading: true
+      show_source: false
+      members_order: source
+      docstring_section_style: table
+      separate_signature: true
+      show_signature_annotations: true
+
+### WebSocket Transport
+
+::: janus_client.transport_websocket.JanusTransportWebsocket
+    options:
+      show_root_heading: true
+      show_source: false
+      members_order: source
+      docstring_section_style: table
+      separate_signature: true
+      show_signature_annotations: true

docs/session.md

@@ -4,24 +4,16 @@ Create a session object that can be shared between plugin handles.
 
 The session is the main entry point for communicating with a Janus WebRTC Gateway server. It manages the connection, handles message routing, and provides lifecycle management for plugins.
 
-## JanusSession
-
-::: janus_client.session.JanusSession
-    options:
-      show_root_heading: true
-      show_source: false
-      members_order: source
-      docstring_section_style: table
-      separate_signature: true
-      show_signature_annotations: true
-
-## PluginAttachFail Exception
-
-::: janus_client.session.PluginAttachFail
-    options:
-      show_root_heading: true
-      show_source: false
-      docstring_section_style: table
+For detailed API documentation, see the [API Reference](reference.md#session-classes).
+
+## Overview
+
+A `JanusSession` represents a connection to a Janus WebRTC Gateway server. It:
+
+- Manages the underlying transport (HTTP or WebSocket)
+- Routes messages between plugins and the server
+- Handles session lifecycle (creation, keepalive, destruction)
+- Provides automatic cleanup through async context managers
 
 ## Usage Examples
 

docs/transport.md

@@ -2,30 +2,16 @@
 
 Transport classes handle the actual communication with the Janus server. The transport method is automatically detected using regex patterns on the base_url parameter passed to the Session object.
 
-## Base Transport Class
+For detailed API documentation, see the [API Reference](reference.md#transport-classes).
 
-::: janus_client.transport.JanusTransport
-    options:
-      show_root_heading: true
-      show_source: false
-      members_order: source
-      docstring_section_style: table
-      separate_signature: true
-      show_signature_annotations: true
+## Overview
+
+The transport layer provides the communication mechanism between your application and the Janus WebRTC Gateway server. The library automatically selects the appropriate transport based on the URL scheme you provide.
 
 ## HTTP Transport
 
 The HTTP transport implementation provides communication with Janus server over HTTP/HTTPS using long polling for receiving messages.
 
-::: janus_client.transport_http.JanusTransportHTTP
-    options:
-      show_root_heading: true
-      show_source: false
-      members_order: source
-      docstring_section_style: table
-      separate_signature: true
-      show_signature_annotations: true
-
 ### HTTP Transport Features
 
 - **Protocol Support**: HTTP and HTTPS
@@ -61,15 +47,6 @@ if __name__ == "__main__":
 
 The WebSocket transport implementation provides real-time, full-duplex communication with the Janus server.
 
-::: janus_client.transport_websocket.JanusTransportWebsocket
-    options:
-      show_root_heading: true
-      show_source: false
-      members_order: source
-      docstring_section_style: table
-      separate_signature: true
-      show_signature_annotations: true
-
 ### WebSocket Transport Features
 
 - **Full-Duplex Communication**: Real-time bidirectional messaging

mkdocs.yml

@@ -93,6 +93,7 @@ nav:
   - Session: session.md
   - Plugins: plugins.md
   - Transport: transport.md
+  - API Reference: reference.md
 
 extra:
   social: