update-docs

Name: update-docs
Availability: InStock
Author: PhDeasy-org

Align English and Chinese documentation with current code behavior.

7|Updated Aug 12, 2025

Search Tags:#documentation #consistency #translation #readme #docs #drift #update

Ready to run

npx skills add https://github.com/PhDeasy-org/schedule-everything --skill update-docs-phdeasy-org

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/PhDeasy-org/schedule-everything/tree/main/.agents/skills/update-docs
Command: npx skills add https://github.com/PhDeasy-org/schedule-everything --skill update-docs-phdeasy-org

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drift between code and docs; keeping English and Chinese docs aligned is time-consuming without automation.

Core Features & Use Cases

Read current codebase and documentation references
Update README.md, README_zh.md, and documentation pages to reflect current behavior
Verify coherence and consistency across English/Chinese docs and references

Quick Start

Update project documentation by running the skill to synchronize text across README and docs with the latest codebase.

Frequently Asked Questions about update-docs

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

FAQPage Schema

How do I fix documentation drift between my code and README files?▼

To fix documentation drift, you need to align your README.md and README_zh.md files with current code behavior by reading the codebase, updating feature descriptions, and verifying link references for coherence.

What is the best way to keep English and Chinese documentation aligned?▼

Keeping English and Chinese docs aligned involves synchronizing text across README.md and README_zh.md by reading the latest codebase updates and applying matching changes to both files to reflect current features and usage.

How do I update documentation pages to reflect current code behavior?▼

Updating documentation pages to reflect current code behavior requires reading the specified project areas, modifying the docs to match tooling configuration and features, and validating coherence with code references.

Can I verify documentation links and examples against the codebase automatically?▼

Yes, you can verify documentation links and examples by running an alignment process that reads the current codebase and validates coherence across README files and documentation pages with code references.

Why does my project README show outdated usage and references after code updates?▼

Your project README shows outdated usage because of documentation drift, which occurs when code evolves without applying matching updates to README.md, README_zh.md, and related documentation pages.

What is documentation drift and when do I need to synchronize docs?▼

Documentation drift is the inconsistency between code behavior and written docs, requiring synchronization when your codebase evolves and your README files and documentation pages no longer reflect current features and references.