skills.rest
IAmKongHai
IAmKongHaiCOMMUNITY
Explore all skills by this author →
GitHub

ce-compound-refresh

Refresh and maintain documentation in 'docs/solutions/' against the current codebase.

Updated May 4, 2026
Search Tags:#documentation#document review#codebase synchronization#automated maintenance#refreshing
One-click install
npx skills add https://github.com/IAmKongHai/compound-engineering-plugin-zh --skill ce-compound-refresh-iamkonghai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: ce-compound-refresh
Source: https://github.com/IAmKongHai/compound-engineering-plugin-zh/tree/main/3.4.2/skills/ce-compound-refresh
Command: npx skills add https://github.com/IAmKongHai/compound-engineering-plugin-zh --skill ce-compound-refresh-iamkonghai

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python, yaml, git, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill automates the refreshing and maintenance of documentation in the 'docs/solutions/' directory, ensuring it remains accurate and relevant against the current codebase.

Core Features & Use Cases

  • Automated Refreshing: Automatically refreshes and updates outdated documentation in 'docs/solutions/'.
  • Documentation Maintenance: Performs a comprehensive review of the documentation, applying updates, consolidations, replacements, or deletions as needed.
  • User Interaction: Allows user interaction for ambiguous cases and decision-making on the maintenance actions.
  • Autofix Mode: Runs in an automated mode without user interaction, applying all unambiguous actions and marking ambiguous cases as stale.
  • Report Generation: Generates a detailed report of the actions taken and any decisions made during the refresh process.
  • Use Case: A developer may use this skill to ensure that all documentation in 'docs/solutions/' is up-to-date with recent changes in the codebase.

Quick Start

Run the ce-compound-refresh skill with the following command: ce-compound-refresh --root .

Frequently Asked Questions about ce-compound-refresh

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

FAQPage Schema
How do I keep documentation in sync with codebase changes automatically?▼

To keep documentation in sync with codebase changes, you can automate the refreshing and maintenance process to review and update outdated files against your current code, ensuring accuracy and relevance without manual intervention.

How do I update outdated solution documents against my current code?▼

Updating outdated solution documents involves performing a comprehensive review against the current codebase to apply updates, consolidations, replacements, or deletions as needed, which can be executed using a root directory command.

Can I run automated documentation maintenance without manual interaction?▼

Yes, you can run automated documentation maintenance without manual interaction using an autofix mode that applies all unambiguous actions automatically and marks ambiguous cases as stale for later review.

What dependencies do I need for codebase documentation synchronization?▼

For codebase documentation synchronization, you need Python, YAML, and Git installed in your environment, along with access to the codebase and necessary tools for file manipulation and data analysis.

How does the system handle ambiguous cases during document review?▼

During document review, the system handles ambiguous cases by allowing user interaction for decision-making on maintenance actions, or by marking them as stale when running in automated autofix mode without user interaction.

Related Skills

Explore More Software Engineering Skills→
Mu2eMu2e

coding-with-metacat

Query and manipulate Mu2e file metadata using the metacat Python API.

Official
Advanced
RDEWAIRDEWAI
5

validate-pipeline

Validate YAML CI/CD pipeline files for syntax, stages, and security.

Official
Intermediate
zangxin75zangxin75

git-helper

Run Git status, pull, branch, and log commands.

Community
Basic
saschadudkin-sketchsaschadudkin-sketch

code-review

Automate code review for rezidence4/DomHub repository changes.

Community
Advanced