mirror of
https://github.com/Comfy-Org/ComfyUI_frontend.git
synced 2026-01-26 19:09:52 +00:00
38525d8f3a
## Summary Adds a new automated workflow that runs weekly to check and update documentation accuracy. ## Changes - Created `.github/workflows/weekly-docs-check.yaml` - Workflow runs every Monday at 9 AM UTC or via manual dispatch - Uses Claude to fact-check all documentation against the current codebase - Automatically creates/updates a draft PR with documentation corrections ## Workflow Features 1. **Schedule**: Runs weekly (Mondays at 9 AM UTC) or on-demand via workflow_dispatch 2. **Documentation Review**: Claude analyzes: - All markdown files in `docs/` - Project guidelines in `CLAUDE.md` - README files throughout the repository - Claude command documentation in `.claude/commands/` 3. **Automated PR Creation**: Uses `peter-evans/create-pull-request` action to: - Create or update the `docs/weekly-update` branch - Generate a draft PR with all documentation updates - Apply `documentation` and `automated` labels ## Benefits - Keeps documentation synchronized with code changes - Identifies outdated API references and deprecated functions - Catches missing documentation for new features - Ensures code examples remain valid and tested ## Test Plan - [x] YAML syntax validated - [ ] Workflow can be manually triggered to verify functionality - [ ] PR creation works as expected 🤖 Generated with [Claude Code](https://claude.com/claude-code) ┆Issue is synchronized with this [Notion page](https://www.notion.so/PR-6298-feat-add-weekly-documentation-accuracy-check-workflow-2986d73d365081d48ce0f4cf181c377f) by [Unito](https://www.unito.io) --------- Co-authored-by: Claude <noreply@anthropic.com>
GitHub Workflows
Naming Convention
Workflow files follow a consistent naming pattern: <prefix>-<descriptive-name>.yaml
Category Prefixes
| Prefix | Purpose | Example |
|---|---|---|
ci- |
Testing, linting, validation | ci-tests-e2e.yaml |
release- |
Version management, publishing | release-version-bump.yaml |
pr- |
PR automation (triggered by labels) | pr-claude-review.yaml |
api- |
External Api type generation | api-update-registry-api-types.yaml |
i18n- |
Internationalization updates | i18n-update-core.yaml |
Documentation
Each workflow file contains comments explaining its purpose, triggers, and behavior. For specific details about what each workflow does, refer to the comments at the top of each .yaml file.
For GitHub Actions documentation, see Events that trigger workflows.