wj-docs-pr

Update Slovak Markdown documentation and CHANGELOG from Git diffs.

7|6|Updated Feb 11, 2022
One-click install
npx skills add https://github.com/webjetcms/webjetcms --skill wj-docs-pr
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: wj-docs-pr
Source: https://github.com/webjetcms/webjetcms/tree/main/.agents/skills/wj-docs-pr
Command: npx skills add https://github.com/webjetcms/webjetcms --skill wj-docs-pr

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill ensures that your project's documentation stays up-to-date with code changes introduced in a Git pull request or local uncommitted edits, preventing documentation drift.

Core Features & Use Cases

  • Automated Documentation Updates: Analyzes Git diffs to identify changes in code files (Java, JS, HTML, config).
  • Targeted Edits: Updates relevant sections of the currently open Markdown file in Slovak.
  • Changelog Integration: Automatically adds entries to the CHANGELOG-2026.md file, including ticket numbers.
  • Use Case: After implementing a new feature and before merging a PR, use this Skill to update the relevant technical documentation and changelog entries, ensuring clarity for future developers.

Quick Start

Update the documentation in the current Markdown file based on the changes in the current Git branch.

Frequently Asked Questions about wj-docs-pr

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

FAQPage Schema
How do I update Markdown documentation based on Git pull request changes?

To update Markdown documentation from Git pull request changes, this Skill analyzes code diffs in Java, JavaScript, HTML, and configuration files, then automatically edits the relevant sections of your currently open Markdown file to reflect the modifications.

Can I generate a changelog entry from uncommitted Git edits?

Yes, you can generate a changelog entry from uncommitted Git edits. This Skill supports documenting either all commits in a pull request or only local uncommitted changes, automatically adding entries with ticket numbers to your changelog file.

Does this documentation sync tool work with Java and JavaScript code changes?

Yes, this documentation sync tool works with Java and JavaScript code changes. It also analyzes modifications in HTML and configuration files to identify what documentation sections need updating in your Markdown files.

How do I keep technical documentation in Slovak synced with code modifications?

To keep technical documentation in Slovak synced with code modifications, this Skill analyzes Git diffs and writes targeted updates directly in Slovak into the relevant sections of your current Markdown file.

What is the best way to prevent documentation drift before merging a Git pull request?

The best way to prevent documentation drift before merging a Git pull request is to analyze code modifications and automatically update the relevant technical Markdown documentation and changelog entries, ensuring clarity for future developers.

Does this changelog generator require specific commit message formats for ticket numbers?

The metadata does not specify a required commit message format for ticket numbers. It confirms that changelog entries are automatically added to the CHANGELOG file including ticket numbers, but does not detail extraction rules.