update-api-artifacts

Rebuild API documentation and audit permissions from source code.

3|Updated Aug 28, 2025

Search Tags:#documentation #api #permissions #code sync #source code analysis

Ready to run

npx skills add https://github.com/mrgeoffrich/mini-infra --skill update-api-artifacts

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: update-api-artifacts
Source: https://github.com/mrgeoffrich/mini-infra/tree/main/.claude/skills/update-api-artifacts
Command: npx skills add https://github.com/mrgeoffrich/mini-infra --skill update-api-artifacts

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and scripts (resource) components.

What problem does it solve?

This Skill ensures that all project documentation accurately reflects the current state of the source code, preventing inconsistencies and outdated information.

Core Features & Use Cases

Rebuild API documentation from route definitions to keep API-ROUTES.md up to date.
Audit access permissions by comparing code-used permissions against the permissions.ts registry.
Spot-check documentation files for stale or inconsistent references, including AGENT.md and CLAUDE.md.
Useful after significant code refactoring or feature updates to maintain reliable documentation.

Quick Start

Trigger the update process to synchronize all API and documentation artifacts with your current codebase.

Frequently Asked Questions about update-api-artifacts

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

FAQPage Schema

How do I sync API documentation with source code after refactoring?▼

Syncing API documentation with source code requires static analysis of route files to automatically rebuild API-ROUTES.md, ensuring documentation accurately reflects the current codebase state.

What is API permissions auditing and how does it work?▼

API permissions auditing compares permissions used in code against the permissions.ts registry, using static analysis to detect and report mismatches between declared and applied access controls.

How do I check for stale references in project documentation files?▼

You can check for stale references in project documentation by spot-checking files like AGENT.md and CLAUDE.md against current source code to identify and correct outdated or inconsistent information.

Can I use static analysis to generate API routes documentation automatically?▼

Yes, static analysis of route definition files can automatically generate API routes documentation by systematically rebuilding artifacts, which is particularly effective for maintaining accuracy in rapidly evolving codebases.

What's the best way to maintain documentation accuracy in a large codebase?▼

Maintaining documentation accuracy in a large codebase is best achieved by systematically rebuilding and auditing documentation artifacts from source code, preventing inconsistencies after significant feature updates or refactoring.

When do I need to regenerate API documentation artifacts?▼

You need to regenerate API documentation artifacts after significant code refactoring or feature updates, ensuring that all project references and route definitions remain current, accurate, and consistent.