skills.rest
cslsoftwares
cslsoftwaresCOMMUNITY
Explore all skills by this author →
GitHub

documentation-readme-hub

Synchronize Documentation/README_Vx.y.md with the current file tree.

Updated Jan 6, 2026
Search Tags:#versioning#documentation#backup#artifacts#sync#mapping#hub
One-click install
npx skills add https://github.com/cslsoftwares/ParamentersORM --skill documentation-readme-hub
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: documentation-readme-hub
Source: https://github.com/cslsoftwares/ParamentersORM/tree/main/.cursor/skills/documentation-readme-hub_V1.1.0
Command: npx skills add https://github.com/cslsoftwares/ParamentersORM --skill documentation-readme-hub

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps the Documentation hub in sync with the canonical set of project artifacts by reflecting migrations, moves and renames without moving the actual files.

Core Features & Use Cases

  • Reconciles Documentation/README_Vx.y.md with Documentation/ and Documentation/Backup/ to avoid broken references.
  • Validates that each subfolder and document is represented in the hub, surfacing discrepancies for review.
  • Non-destructive operation: only updates the hub index, never moves or renames actual documents.

Quick Start

Atualize o hub Documentation/README_Vx.y.md para refletir o estado canônico dos artefatos documentais.

Frequently Asked Questions about documentation-readme-hub

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

FAQPage Schema
How do I sync my documentation hub after a project restructuring?▼

A documentation hub sync updates the README_Vx.y.md index to match the canonical file tree in Documentation/ and Documentation/Backup/. It reconciles paths after migrations or restructurings without moving actual files.

How do I update README file tree references without moving files?▼

Updating README file tree references without moving files is achieved through non-destructive hub synchronization. The Skill only modifies the hub index to reflect real paths, ensuring actual documents remain untouched.

What is documentation hub reconciliation with backup artifacts?▼

Documentation hub reconciliation with backup artifacts validates that every subfolder and document in Documentation/ and Documentation/Backup/ is represented. It surfaces discrepancies for review to avoid broken references.

Does documentation hub synchronization delete or rename existing files?▼

Documentation hub synchronization does not delete or rename existing files. It enforces non-destructive updates, meaning only the hub index is modified while all actual documents remain safely in place.

When should I run a documentation hub alignment?▼

You should run a documentation hub alignment after migrations, restructurings, or any update to Documentation/ and Documentation/Backup/ folders. This keeps the hub aligned with the current canonical project artifacts.

Related Skills

Explore More Content & Communication Skills→
VictorHueniVictorHueni

util-metamodel-scaffold

Generate a canonical docs folder tree and live index.md navigation hub.

Community
Advanced
cslsoftwarescslsoftwares

documentation-portal-html

Plan and orchestrate static HTML documentation portals under Documentation/html/.

Community
Advanced
cslsoftwarescslsoftwares

documentation-architecture

Create and update canonical architecture documents under Documentation/Arquitetura/.

Community
Advanced
benjaminshoemakerbenjaminshoemaker
39

update-docs

Analyze commit ranges or working tree changes to update documentation files.

Community
Advanced