wx44wx/pipecat
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Broaden /update-docs scope to detect missing doc sections

Browse Source
This commit is contained in:
Mark Backman
2026-02-13 13:14:45 -05:00
parent 2454bedf29
commit f7af9f1efd
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
.claude/skills/update-docs/SKILL.md
View File

@@ -146,17 +146,17 @@ Guide directories:
- `guides/features/` — feature-specific guides (Gemini Live, OpenAI audio, WhatsApp, etc.)
- `guides/telephony/` — telephony integration guides (Twilio, Plivo, Telnyx, etc.)
### Step 8: Handle unmapped files
### Step 8: Identify doc gaps
After processing all mapped pairs, report any source files that:
- Had no doc page mapping (neither tier 1, 2, nor 3)
- Are not marked as "(skip)" in the tier-1 table
After processing all mapped pairs, check for two kinds of gaps:
For each unmapped file, tell the user:
**Missing pages**: Source files that had no doc page mapping (neither tier 1, 2, nor 3) and are not marked as "(skip)". For each, tell the user:
- The source file path
- The main class(es) it defines
- Whether a new doc page should be created
**Missing sections**: Mapped doc pages that are missing standard sections compared to the source. For example, a transport page with no Configuration section, or a service page with no InputParams table when the source defines `InputParams(BaseModel)`. Flag these and offer to add the missing sections.
If the user wants a new page, create it using this template structure:
```
---

4
.claude/skills/update-docs/SOURCE_DOC_MAPPING.md
View File

@@ -22,7 +22,8 @@ These source paths don't follow the standard `services/{provider}/{type}.py` →
| `processors/user_idle_processor.py` | `server/utilities/user-idle-processor.mdx` |
| `processors/idle_frame_processor.py` | `server/pipeline/pipeline-idle-detection.mdx` |
| `pipeline/task.py` | `server/pipeline/pipeline-task.mdx` |
| `runner/run.py` | `server/utilities/runner/guide.mdx` |
| `pipeline/runner.py` | `server/utilities/runner/guide.mdx` |
| `transports/base_transport.py` | `server/services/transport/transport-params.mdx` |
## Skip list
@@ -40,7 +41,6 @@ These files should never trigger doc updates.
| `services/gemini_multimodal_live/**` | Deprecated |
| `services/aws/agent_core.py` | Internal |
| `services/aws/sagemaker/**` | No doc page |
| `transports/base_transport.py` | Internal base class |
| `transports/base_input.py` | Internal base class |
| `transports/base_output.py` | Internal base class |
| `transports/websocket/client.py` | No doc page |