docs

Audit project documentation against the live codebase and update README files, environment variables, and OpenAPI metadata.

Updated Feb 13, 2026

Search Tags:#documentation #technical writing #configuration management #api documentation #readme update #codebase sync

Ready to run

npx skills add https://github.com/g-zenr/relay-api --skill docs-g-zenr

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs
Source: https://github.com/g-zenr/relay-api/tree/main/.claude/skills/docs
Command: npx skills add https://github.com/g-zenr/relay-api --skill docs-g-zenr

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill ensures that project documentation accurately reflects the current state of the codebase, preventing outdated information and improving developer onboarding and understanding.

Core Features & Use Cases

Comprehensive Audit: Compares documentation against the codebase, identifying discrepancies.
Targeted Updates: Focuses on README files, environment variable configurations, and API endpoint details.
Use Case: After updating API endpoints or adding new configuration options, use this Skill to automatically update the project's README and configuration documentation to match.

Quick Start

Update all project documentation to match the current codebase.

Frequently Asked Questions about docs

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

FAQPage Schema

How do I sync documentation with my codebase after updating API endpoints?▼

You can sync documentation with your codebase by running an audit that compares existing files against the live application. This process updates README files, environment variable configurations, and OpenAPI metadata to accurately reflect new API endpoints and configuration settings.

What is the best way to update README files and environment variable configurations?▼

The best way to update README files and environment variable configurations is through a comprehensive audit of existing documentation against the current codebase. This identifies discrepancies and applies targeted updates to ensure configuration details and feature lists match the live application.

How does documentation synchronization handle OpenAPI metadata and API endpoint tables?▼

Documentation synchronization handles OpenAPI metadata by auditing the live application and its configuration settings. It ensures accuracy in API endpoint tables and OpenAPI metadata by directly comparing these documentation components against the actual codebase implementation.

Can I automatically update project documentation to match new configuration options?▼

Yes, you can automatically update project documentation to match new configuration options. The Skill performs a thorough audit of existing documentation against the codebase, focusing on README files and environment variable configurations to ensure all details accurately reflect current settings.

When do I need to audit existing documentation against a live application?▼

You need to audit existing documentation against a live application after updating API endpoints or adding new configuration options. This comprehensive comparison prevents outdated information, identifies discrepancies, and improves developer onboarding and understanding of the project.

Does documentation synchronization require specific dependencies to update technical writing?▼

No, documentation synchronization requires no external dependencies to update technical writing. It independently performs a thorough audit of your existing documentation against the live application and its configuration settings to ensure accuracy across all project files.