docs

Update README and docs files to match the current codebase state.

1|Updated May 26, 2026

Search Tags:#documentation #repository maintenance #local-first #feature docs #cli help #readme sync #grounded edits

Ready to run

npx skills add https://github.com/Leonardo-Corte/local-social-smm-agent --skill docs-leonardo-corte

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/Leonardo-Corte/local-social-smm-agent/tree/main/reference/github-agent-orchestration/maestro/.claude/skills/docs
Command: npx skills add https://github.com/Leonardo-Corte/local-social-smm-agent --skill docs-leonardo-corte

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps repository documentation accurate by updating README and docs based on the current codebase instead of relying on a remote documentation command or stale descriptions.

Core Features & Use Cases

Repository documentation sync: Updates README.md and relevant docs/*.md for full-repo “sync README” or “update the docs” requests.
Targeted single-file edits: Refreshes an explicitly named documentation file (for example AGENTS.md or CLAUDE.md) without touching unrelated files.
Feature documentation extension: Expands an existing feature’s documentation by aligning it with the real implementation, including checking the feature’s index.ts, services.ts, and commands/ for the actual public surface.
Grounded, verification-driven edits: Performs required reads and confirms commands using --help before documenting flags or behavior to avoid unverified claims.
Safe working-tree changes: Edits files in the working tree without opening a PR and leaves changes for the user to review and commit.

Quick Start

Ask the AI to update the docs by syncing the README and relevant docs files to match the current codebase state.

Frequently Asked Questions about docs

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

FAQPage Schema

How do I sync README and documentation files with my current codebase state?▼

You can sync README and docs with your current codebase state by requesting a full documentation sync that updates README.md and relevant docs/*.md files. The process reads concrete implementation artifacts like index.ts, services.ts, and commands to ensure docs reflect the actual public surface.

What is the best way to update documentation for a specific feature without affecting unrelated files?▼

The best way to update feature documentation safely is through targeted single-file edits that align docs with the real implementation. This feature-specific doc expansion checks the feature's index.ts, services.ts, and commands/ directory to accurately document the actual public surface without touching unrelated files.

How do you verify CLI flags and command behavior before writing documentation?▼

To verify CLI flags and command behavior before writing documentation, the process requires running commands with the --help flag and performing grounded reads of project files like AGENTS.md and CLAUDE.md. This verification-driven approach prevents documenting unverified claims about CLI behavior.

Can I refresh a single documentation file like AGENTS.md without triggering a full repository sync?▼

Yes, you can refresh a single explicitly named documentation file such as AGENTS.md or CLAUDE.md without triggering a full repository sync. The targeted single-file edit capability refreshes only the specified file and leaves unrelated documentation untouched, ensuring surgical local edits.

Does updating repository documentation automatically open a pull request or commit changes directly?▼

Updating repository documentation does not automatically open a pull request or commit changes directly. The process applies safe working-tree changes by editing files locally and leaving them in the working tree for you to review and commit manually, ensuring user control over version control.

What are the limitations when editing protected memory or mission files during a documentation sync?▼

A key limitation during documentation sync is that surgical local edits must not touch protected Maestro or Claude memory and missions. The process strictly updates README and docs based on the current codebase while preserving these protected files from any modifications.