ucl-update-docs

Update Markdown documentation metadata and cross-links after code changes.

4|Updated Apr 3, 2020
One-click install
npx skills add https://github.com/tim099/UCL_Core --skill ucl-update-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ucl-update-docs
Source: https://github.com/tim099/UCL_Core/tree/main/Skills~/ucl-update-docs
Command: npx skills add https://github.com/tim099/UCL_Core --skill ucl-update-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill resolves the challenge of maintaining up-to-date documentation after code modifications, preventing discrepancies between code and docs that can cause confusion and errors.

Core Features & Use Cases

  • Identify Corresponding Files: Automatically find matching Markdown documentation for updated code files based on naming, namespace, or source path.
  • Update Metadata and Cross-Links: Enhance frontmatter fields like last_updated and maintain related references to ensure consistency across documentation.
  • Use Case: When a developer modifies a C# class in Unity, this Skill helps update the relevant API documentation to reflect the latest interface details, maintaining accurate references for teammates and users.

Quick Start

Use this skill after editing code files to automatically locate the related documentation and update the frontmatter fields, ensuring the documentation remains current.

Frequently Asked Questions about ucl-update-docs

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

FAQPage Schema
How do I keep markdown documentation synchronized with code changes automatically?

To sync markdown documentation with code changes, this skill automates finding matching markdown files for updated source code. It parses source paths and naming conventions to update frontmatter metadata and maintain cross-reference consistency.

How does metadata synchronization handle multiple source locations and language versions?

Metadata synchronization across multiple language versions works by parsing source paths, file naming conventions, and namespaces. It accurately locates the corresponding markdown documentation files and applies precise frontmatter updates regardless of the source location.

Can I use this to update frontmatter fields like last_updated for modified C# classes?

Yes, you can update frontmatter fields like last_updated for modified C# classes. The skill locates the related API documentation based on the source path and automatically enhances the metadata to reflect the latest interface details.

What is the best way to maintain cross-reference consistency between source code and markdown files?

The best way to maintain cross-reference consistency between source code and markdown files is to automate the linking process. This skill updates related references in the frontmatter and applies metadata changes whenever corresponding code files are modified.

Do I need specific file naming conventions for code documentation sync to work properly?

Yes, specific file naming conventions are required for code documentation sync to work properly. The skill relies on parsing source paths, namespaces, and naming patterns to accurately identify the corresponding markdown documentation files for precise metadata updates.