update-docs

Audit and update Markdown documentation to match repository structure and git history.

2|1|Updated Mar 16, 2026

Search Tags:#git #changelog #architecture #documentation #readme #docs #oss

Ready to run

npx skills add https://github.com/rioX432/live-translate --skill update-docs-riox432

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/rioX432/live-translate/tree/main/.claude/skills/update-docs
Command: npx skills add https://github.com/rioX432/live-translate --skill update-docs-riox432

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill audits and updates project documentation so README files, architecture notes, changelogs, and OSS policy pages stay accurate as the codebase changes.

Core Features & Use Cases

Documentation Audit: Compares the repository structure, git history, and existing markdown files to find outdated or missing content.
Targeted Doc Updates: Updates architecture, changelog, README cross-references, and standard OSS documents without rewriting sections that are still correct.
Link Verification: Checks internal markdown links after edits so documentation stays navigable and consistent.
Use Case: Use this Skill when a project has evolved and you need its docs refreshed to match the current implementation and repository layout.

Quick Start

Ask the assistant to audit the repository docs and update the selected documentation scope.

Frequently Asked Questions about update-docs

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

FAQPage Schema

How do I keep project documentation aligned with code changes?▼

To keep project documentation aligned with code changes, you can audit the repository structure, git history, and markdown files to identify outdated content, then apply targeted updates to architecture notes and changelogs.

What is the best way to update a changelog from git commits and tags?▼

Updating a changelog from git commits involves scanning project history and tags to detect missing entries, then appending accurate release notes while preserving existing correct sections.

How do I verify internal markdown links after updating README cross-references?▼

Verifying internal markdown links after updating README cross-references requires checking the modified documentation structure to ensure navigability and prevent broken paths.

Can I audit OSS policy files and architecture notes without rewriting correct sections?▼

You can audit OSS policy files and architecture notes without rewriting correct sections by comparing existing markdown content against the current repository layout and applying only targeted patches.

When do I need to scan my repository structure for missing documentation files?▼

You need to scan your repository structure for missing documentation files when a project has evolved significantly and its README, architecture notes, or OSS policy pages no longer match the implementation.

Does updating docs with this method preserve existing accurate markdown content?▼

Updating docs with this method preserves existing accurate markdown content by scanning internal links, git tags, and commits to refresh only outdated or missing documentation files.