skills.rest
zdpk
zdpkCOMMUNITY
Explore all skills by this author →
GitHub

manual-sync

Synchronize SNPortal documentation and API references against the codebase.

Updated Jan 23, 2026
Search Tags:#documentation#drift#api-reference#snportal#manual-sync#commit-hook
One-click install
npx skills add https://github.com/zdpk/skills --skill manual-sync
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: manual-sync
Source: https://github.com/zdpk/skills/tree/main/dotfiles/skills/custom/project/manual-sync
Command: npx skills add https://github.com/zdpk/skills --skill manual-sync

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation drift is common: SNPortal manual, API references, and related counters fall out of sync with the codebase, making it hard to trust docs or share accurate information.

Core Features & Use Cases

  • Automated synchronization of manual docs, API references, and counters from the codebase.
  • Commit-hook integration to keep docs up to date during development and before releases.
  • Runtime + static sources comparison to surface drift and update docs automatically.

Quick Start

Run python3 scripts/sync_manual_stats.py to synchronize the SNPortal manual and API references.

Frequently Asked Questions about manual-sync

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

FAQPage Schema
How do I keep SNPortal documentation in sync with my codebase?▼

To keep SNPortal documentation in sync with your codebase, run python3 scripts/sync_manual_stats.py to automatically update manual docs, API references, and counters from runtime OpenAPI data and static sources.

What is documentation drift and how do I detect it in SNPortal?▼

Documentation drift occurs when SNPortal manual and API references fall out of sync with code. Drift is detected by comparing runtime OpenAPI data against static sources to surface discrepancies in endpoints, schemas, and counters.

Can I use a commit hook to automatically update SNPortal API references?▼

Yes, you can install a commit hook to automatically update SNPortal API references and manual docs during development and before releases, ensuring counters for OpenAPI endpoints and JPA entities remain accurate.

Do I need Python 3 to run the SNPortal manual sync script?▼

Yes, Python 3 is required to run scripts/sync_manual_stats.py. The script relies on Python 3 and your local repository to compute drift and update the docs/manual directory and API references.

What specific counters does the SNPortal documentation sync update?▼

The SNPortal documentation sync updates counters for OpenAPI endpoints, schemas, JPA entities, Atlas tables, services, finders, modifiers, and tests within the manual and API references.

Related Skills

Explore More Content & Communication Skills→
BlocUnited-LLCBlocUnited-LLC
14

setup

Set up a Mozaiks development environment with dependencies and environment variables.

Official
Intermediate
l3ochol3ocho

sync-workflow

Detect documentation drift and apply batch updates with a single commit message.

Community
Advanced
SantiagoisperSantiagoisper

lfg

Automate the full engineering pipeline from planning to CI loop.

Community
Advanced
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate