update-public-docs

Update MDX API reference docs to match Python source files.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/yyiilluu/reflexio --skill update-public-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-public-docs
Source: https://github.com/yyiilluu/reflexio/tree/main/.claude/skills/update-public-docs
Command: npx skills add https://github.com/yyiilluu/reflexio --skill update-public-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and scripts (resource) components.

What problem does it solve?

This Skill ensures that the public API reference documentation accurately reflects the current state of the Python source code, preventing outdated information and developer confusion.

Core Features & Use Cases

  • Automated Documentation Sync: Compares Python source files (client library, schemas, config models) against existing MDX documentation.
  • Discrepancy Identification & Correction: Automatically updates documentation to include new methods/fields, correct parameters/types, and remove obsolete entries.
  • Use Case: After updating the ReflexioClient in client.py with a new method, run this Skill to automatically generate the corresponding documentation in the api-reference/client-*.mdx files.

Quick Start

Run the update-public-docs skill to synchronize the documentation with the latest code changes.

Frequently Asked Questions about update-public-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I sync Python API reference documentation with source code?

To sync Python API reference documentation with source code, run the update-public-docs skill to compare client.py, Pydantic models, and enums against existing MDX files and correct discrepancies. It ensures public docs match the latest code changes.

How does automated documentation sync handle Pydantic models and enums?

Automated documentation sync handles Pydantic models and enums by validating their definitions in Python source files against existing MDX documentation. It identifies mismatches and updates docs to accurately reflect current parameters and types.

Can I automatically generate MDX files for new client methods in Python?

Yes, you can automatically generate MDX files for new client methods. After adding a new method to the ReflexioClient in client.py, run the skill to generate corresponding documentation in the api-reference/client-*.mdx files.

What's the best way to validate API docs against Python source files?

The best way to validate API docs against Python source files is using an automated sync tool that compares code structure directly with MDX documentation. This process checks build integrity and removes obsolete entries.

Does this documentation sync process require any external dependencies?

No, this documentation sync process requires no external dependencies. It operates directly on Python source files and MDX documentation within the reflexio/public_docs/ directory to validate and update content.