github-readme-maintenance

Maintains GitHub repository README and documentation files with verified minimal diffs.

115|9|Updated Aug 5, 2026
One-click install
npx skills add https://github.com/AtlasOmnia/donna-starter --skill github-readme-maintenance-atlasomnia
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: github-readme-maintenance
Source: https://github.com/AtlasOmnia/donna-starter/tree/main/skills/github/github-readme-maintenance
Command: npx skills add https://github.com/AtlasOmnia/donna-starter --skill github-readme-maintenance-atlasomnia

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Editing repository-facing documentation like README.md or AGENTS.md often leads to wrong-checkout edits, broken links, formatting drift, and unreviewable diffs. This Skill provides a deterministic workflow that pins the target repository and branch, verifies context before editing, and validates the final diff so documentation changes stay accurate and review-friendly. ## Core Features & Use Cases - Checkout and Branch Verification: Confirms the target repository path, remote, and current branch before any edit, preventing changes in the wrong local clone. - Minimal, Validated Edits: Enforces small localized changes with explicit Markdown list and link formatting rules, then checks the diff for unintended churn. - Publication Verification: After pushing, compares remote branch SHAs, reads the raw remote README, and confirms GitHub renders the new commit with passing CI checks. - Use Case: You need to update a link in a project README that exists in two local clones. The Skill walks you through confirming the correct checkout, editing only the intended lines, and verifying the published result on GitHub. ## Quick Start Ask the agent to update a specific section of the README in a given repository path and verify the change after pushing.

Frequently Asked Questions about github-readme-maintenance

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

FAQPage Schema
How do I safely update a GitHub README without breaking formatting?

Pin the target repository path and branch first, verify the section exists in the working tree, then make a minimal edit and review the diff with git diff before committing. Keep Markdown bullets as plain list syntax and match surrounding link style.

How to edit repository docs when I have multiple local clones?

Verify every candidate checkout by running git remote -v and git rev-parse --abbrev-ref HEAD in each one before editing. Editing the wrong clone produces unlinked commits and confusing diffs, so treat the target path and branch as explicit inputs.

Should I delete image files when removing screenshots from a README?

Remove only the Markdown or HTML references first. Delete the underlying asset files only if the user explicitly asks or the assets are confirmed unused everywhere else in the repository.

What should go into AGENTS.md or CLAUDE.md documentation?

Document stable architecture, ownership boundaries, generated-file rules, safety invariants, and executable verification commands. Keep temporary campaign state, process IDs, and one-time acceptance evidence out of durable repository instructions.

How do I verify a README change was published correctly on GitHub?

After pushing, confirm the remote branch SHA matches the local commit, read the raw remote README to check the edit is present, and fetch the public repository page to confirm GitHub renders the new commit with required CI checks passing.