docs-update

Automate SSOT-compliant edits to Markdown documentation files under docs/.

126|41|Updated Aug 4, 2018
One-click install
npx skills add https://github.com/hiromaily/go-crypto-wallet --skill docs-update
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-update
Source: https://github.com/hiromaily/go-crypto-wallet/tree/main/.claude/skills/docs-update
Command: npx skills add https://github.com/hiromaily/go-crypto-wallet --skill docs-update

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a structured workflow for updating repository documentation, ensuring all changes stay aligned with the SSOT (single source of truth) and cross-references remain accurate.

Core Features & Use Cases

  • SSOT-aware edits: Directs contributors to identify SSOT locations before editing and to reference official sources rather than duplicating information.
  • Guided workflow: Enforces the use of the git-workflow Skill for branches, commits, and PRs to maintain consistent history.
  • Documentation hygiene: Preserves formatting, cross-links, and standards across Markdown files like AGENTS.md, docs/, and task-contexts.

Quick Start

Use the docs-update skill when you modify any Markdown file in the repository to ensure SSOT references remain intact and changes are committed through the standard workflow.

Frequently Asked Questions about docs-update

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

FAQPage Schema
How do I update Markdown documentation while preserving cross-references?

To update Markdown documentation while preserving cross-references, this Skill directs you to identify the SSOT location first, ensuring you edit official sources rather than duplicating information. It maintains cross-links and consistent formatting across files like AGENTS.md and docs/.

What is the best way to keep documentation aligned with a single source of truth?

Keeping documentation aligned with a single source of truth involves preventing information duplication across Markdown files. This Skill enforces SSOT compliance by requiring contributors to reference official sources directly when editing standards, guidelines, and design docs.

How do I commit documentation changes through a standard git workflow?

To commit documentation changes through a standard git workflow, this Skill mandates using the git-workflow Skill for branches, commits, and PRs. This guided approach ensures repository history remains consistent when updating Markdown files.

Can I use this to edit agent instructions and task-contexts?

Yes, you can use this to edit agent instructions and task-contexts. The Skill applies to modifying any Markdown files under docs/ and related SSOT references, ensuring formatting and cross-references remain intact during repository documentation updates.

Do I need a separate git workflow tool to submit documentation updates?

Yes, you need the git-workflow Skill to submit documentation updates. This Skill enforces its use for handling branches, commits, and pull requests to maintain a consistent version control history when modifying Markdown documentation.