Merge pull request #494 from pipecat-ai/mb/0.0.99-docs-updates

0.0.99 docs cleanup, add CI for broken link detection

Author: markbackman

.github/workflows/broken-links.yml

@@ -0,0 +1,43 @@
+name: Check for Broken Links
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+  # Allow manual trigger
+  workflow_dispatch:
+
+jobs:
+  check-links:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install Mintlify CLI
+        run: npm install -g mint
+
+      - name: Check for broken links
+        run: mint broken-links
+        continue-on-error: false
+
+      - name: Comment on PR (if failed)
+        if: failure() && github.event_name == 'pull_request'
+        uses: actions/github-script@v7
+        with:
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: '❌ **Broken links detected!**\n\nPlease check the workflow logs for details on which links are broken and fix them before merging.'
+            })

server/frameworks/rtvi/google-rtvi-observer.mdx

@@ -53,7 +53,7 @@ This observer should replace the base `RTVIObserver` and be set up exactly the s
 from pipecat.services.google.rtvi import GoogleRTVIObserver
 
 # Create the RTVIProcessor
-rtvi = RTVIProcessor(config=RTVIConfig(config=[]))
+rtvi = RTVIProcessor()
 
 # Add to pipeline
 pipeline = Pipeline([

server/frameworks/rtvi/rtvi-processor.mdx

@@ -10,10 +10,10 @@ The `RTVIProcessor` manages bidirectional communication between clients and your
 Add the `RTVIProcessor` to your pipeline:
 
 ```python
-from pipecat.processors.rtvi import RTVIProcessor, RTVIConfig, RTVIServiceConfig
+from pipecat.processors.frameworks.rtvi import RTVIProcessor
 
 # Create the RTVIProcessor
-rtvi = RTVIProcessor(config=RTVIConfig(config=[]))
+rtvi = RTVIProcessor()
 
 # Add to pipeline
 pipeline = Pipeline([