readme-edit

Apply structured edit actions to README files in a specified order.

807|122|Updated Mar 8, 2022
One-click install
npx skills add https://github.com/getkyo/kyo --skill readme-edit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: readme-edit
Source: https://github.com/getkyo/kyo/tree/main/.claude/skills/readme-edit
Command: npx skills add https://github.com/getkyo/kyo --skill readme-edit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Editing a README by hand is error-prone and slow when you need to apply a structured sequence of edits consistently. This skill provides a mechanical, rule-driven approach to apply a predefined action list to a README without diagnosing content.

Core Features & Use Cases

  • Apply a fixed set of edit operations (CUT, RELOCATE, RESTRUCTURE, REWRITE-HEADING, REORDER, ADD-CALLOUT) to transform README documents.
  • Enforce an execution order, preserve formatting, and ensure changes are repeatable across multiple READMEs.
  • Use cases include refining project documentation, reorganizing sections, updating headings, and inserting callouts based on a validated action list.

Quick Start

Provide the path to the README and the ordered action list, then run the tool to apply changes.

Frequently Asked Questions about readme-edit

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

FAQPage Schema
How do I automate mechanical README edits across multiple sections?

Automating README edits requires applying a structured action list to perform mechanical operations like CUT, RELOCATE, and RESTRUCTURE across sections. This approach enforces an execution order to transform text, headings, and layout consistently without manual intervention.

What is the best way to reorder sections and update headings in a README?

Reordering sections and updating headings is best handled by applying a predefined action list with REORDER and REWRITE-HEADING operations. This rule-driven method performs mechanical edits to adjust text and layout while preserving formatting and ensuring repeatable changes.

How does a structured action list apply changes to a README document?

A structured action list applies changes by executing specified edit operations in a strict order. The tool takes inputs like the readme_path and action_list, processes each action sequentially, and includes a post-edit verification step to ensure the mechanical edits are correctly applied.

Can I use automated text-editing to insert callouts into markdown documentation?

Automated text-editing can insert callouts into markdown documentation using the ADD-CALLOUT action. By including this operation in your action list, the tool mechanically adds callout blocks to your README sections during the structured editing workflow.

Do I need to diagnose content issues before applying automated README edits?

You do not need to diagnose content issues before applying automated README edits. This tool provides a mechanical, rule-driven approach to execute a validated action list, focusing strictly on applying structural changes rather than analyzing or diagnosing the documentation content.

What are the limitations of using structured actions for documentation editing?

Structured actions for documentation editing are limited to mechanical transformations defined in the action list, such as CUT, RELOCATE, and REWRITE-HEADING. The tool does not diagnose content or handle semantic rewriting, meaning it cannot generate new documentation or fix contextual writing issues.