Public Documentation Sync
Synchronizes public MDX API reference documentation with Python source code to ensure accuracy and consistency.
The Public Documentation Sync skill automates the tedious task of keeping external documentation aligned with the actual codebase. It analyzes Python client methods, Pydantic models, enums, and configuration schemas to detect discrepancies in your MDX documentation files. By cross-referencing authoritative source files with existing content, it automatically updates parameter types, return values, and descriptions, while also identifying and removing stale information. Finally, it validates the documentation by running a build check, ensuring that your public-facing guides and API references are always up-to-date and error-free.
主要功能
01Automated synchronization between Python source code and MDX documentation
02Comprehensive updates for client methods, parameters, and return types
03Integrated documentation build verification using Next.js
04655 GitHub stars
05Deep analysis of Pydantic models, enums, and configuration schemas
06Stale documentation detection and removal for deprecated features
使用场景
01Keeping public API references current after major backend refactoring
02Validating that documentation build processes pass after content updates
03Ensuring new Pydantic model fields are correctly documented in schema tables