api-docs-updater

Synchronize Chinese API documentation with code changes by comparing docstrings and updating rst files.

285|906|Updated Jun 7, 2018
One-click install
npx skills add https://github.com/PaddlePaddle/docs --skill api-docs-updater
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-docs-updater
Source: https://github.com/PaddlePaddle/docs/tree/main/docs/dev_guides/coding_agent/api_compatibility/.claude/skills/api-docs-updater
Command: npx skills add https://github.com/PaddlePaddle/docs --skill api-docs-updater

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill automates the process of updating Chinese API documentation to match recent code changes, preventing inconsistencies between code and documentation.

Core Features & Use Cases

  • Automated Documentation Synchronization: Compares API code strings and docstrings with existing Chinese documentation.
  • Consistency Validation: Detects discrepancies between English API descriptions and Chinese translations.
  • Use Case: Developers update API functionalities; this Skill updates the Chinese docs accordingly to reflect the latest API behavior and structure.

Quick Start

Use this Skill to automatically update Chinese API documentation files after modifying the API codebase to ensure accuracy.

Frequently Asked Questions about api-docs-updater

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

FAQPage Schema
How do I synchronize Chinese API documentation with latest code changes?

You can synchronize Chinese API documentation with latest code changes by comparing API code strings and docstrings against existing translations, then automatically updating the relevant rst files to reflect new behavior.

What is continuous localization for API documentation?

Continuous localization for API documentation is the ongoing process of detecting discrepancies between English API descriptions and Chinese translations, then updating docstrings and rst files to maintain consistency across software development workflows.

How do I detect inconsistencies between English API docstrings and Chinese translations?

To detect inconsistencies between English API docstrings and Chinese translations, the documentation synchronization process compares the latest code strings with existing rst files and flags any discrepancies for automated updating.

Does the API documentation updater work with rst files?

Yes, the API documentation updater works directly with rst files. It compares API docstrings with existing Chinese translations and updates the relevant rst files to ensure documentation accuracy after codebase modifications.

Can I automate documentation updates after modifying the API codebase?

Yes, you can automate documentation updates after modifying the API codebase. The synchronization process reads the updated docstrings and automatically applies the corresponding changes to the Chinese API documentation files.

What are the limitations of automating Chinese API documentation synchronization?

Automating Chinese API documentation synchronization relies on comparing existing docstrings and rst files, meaning it requires pre-existing Chinese translations to validate against and cannot generate entirely new localized documentation from scratch.