[PR #6] [MERGED] [ci] Add README documentation check workflow #11

New issue

Closed

opened 2026-10-26 22:06:52 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-26 22:06:52 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-claude-prompt-library/pull/6
Author: @christian-byrne
Created: 6/8/2025
Status: ✅ Merged
Merged: 6/8/2025
Merged by: @christian-byrne

Base: master ← Head: feat/add-readme-documentation-check

📝 Commits (1)

d04c84d [ci] Add README documentation check workflow

📊 Changes

1 file changed (+85 additions, -0 deletions)

View changed files

➕ .github/workflows/check-readme-documentation.yml (+85 -0)

📄 Description

Automatically ensure new commands are properly documented in the README.

Changes

Add GitHub workflow that runs on PRs with command file changes
Check if README.md was updated when new command files are added
Verify new commands are actually referenced in the README with proper documentation
Provide helpful error messages with documentation format examples

This ensures the command library remains well-documented and discoverable for all team members.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/comfy-claude-prompt-library/pull/6 **Author:** [@christian-byrne](https://github.com/christian-byrne) **Created:** 6/8/2025 **Status:** ✅ Merged **Merged:** 6/8/2025 **Merged by:** [@christian-byrne](https://github.com/christian-byrne) **Base:** `master` ← **Head:** `feat/add-readme-documentation-check` --- ### 📝 Commits (1) - [`d04c84d`](https://github.com/Comfy-Org/comfy-claude-prompt-library/commit/d04c84d5ef42901f9292e110c4f46abc7d34e518) [ci] Add README documentation check workflow ### 📊 Changes **1 file changed** (+85 additions, -0 deletions) <details> <summary>View changed files</summary> ➕ `.github/workflows/check-readme-documentation.yml` (+85 -0) </details> ### 📄 Description Automatically ensure new commands are properly documented in the README. ## Changes - Add GitHub workflow that runs on PRs with command file changes - Check if README.md was updated when new command files are added - Verify new commands are actually referenced in the README with proper documentation - Provide helpful error messages with documentation format examples This ensures the command library remains well-documented and discoverable for all team members. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-26 22:06:52 +00:00