diff --git a/.github/skills/update-hints/SKILL.md b/.github/skills/update-hints/SKILL.md index 66b44efcc..3248803f4 100644 --- a/.github/skills/update-hints/SKILL.md +++ b/.github/skills/update-hints/SKILL.md @@ -16,6 +16,7 @@ Scan UI definitions and components in `modules/ui*.py`, `scripts/*.py`, and buil - Reviewing UI hints for factual accuracy against current backend/pipeline implementations. - Identifying and reporting incorrect hints without making automated destructive changes. - Checking for labels exceeding the 63-character limit or broken `...` cross-references. +- Checking for very long hints (e.g. `len(hint) > 500` characters) that may benefit from condensing. - Preparing an audit report of hint status across the codebase. ## Guidance @@ -32,6 +33,13 @@ Scan UI definitions and components in `modules/ui*.py`, `scripts/*.py`, and buil - `extensions-builtin/**/*.py`: Built-in extension UI elements. - `test/validate-locale.py`: Validation script for checking duplicate labels, missing hints, long labels, and formatting. +## Priority Ordering + +When identifying and drafting missing hints, prioritize the following sources: +- **High-Priority Items**: UI controls from `modules/ui_control.py` (and `modules/ui_control_*.py`), `modules/ui_video.py` (and sub-modules in `modules/video_models/` and `modules/minimax/`), `modules/ui_postprocessing.py`, and `modules/ui_caption.py`, including all nested UI controls instantiated via helper functions (e.g. `ui_sections.py`, `ui_guidance.py`, `ui_common.py`, `masking.py`, `create_ui_outputs()`, etc.). +- **Medium-Priority Items**: All settings defined in `modules/ui_definitions.py` (`options_templates` OptionInfo definitions). +- **Lower-Priority Items**: Script UI definitions in `scripts/*.py`, built-in extension elements in `extensions-builtin/`, model management tabs, and sub-level interface controls. + ## Typography and Formatting Rules Hint strings render as HTML. Use only the following tags: @@ -45,7 +53,7 @@ Hint strings render as HTML. Use only the following tags: ### Content Guidelines -- **Concise & Direct**: Keep hints short and focused. Describe the exact argument or function of the control without filler words (avoid phrases like "This button allows you to..."). +- **Concise & Direct**: Keep hints short and focused (typically under 500 characters). Describe the exact argument or function of the control without filler words (avoid phrases like "This button allows you to..."). - **Recommended Values**: If there is a specific recommended value or range for a given use-case (e.g. recommended CFG scale for specific architectures or recommended step counts), add it briefly, but only if necessary. - **Unified Tab Reference**: Always refer to the primary generation tab as `Images` (the ModernUI label). Never write "Control tab". - **Structure**: @@ -53,7 +61,7 @@ Hint strings render as HTML. Use only the following tags: - Use `

` for paragraph breaks. - Use `
- key: description` for short keyed bullet lists (e.g. dropdown options or mode descriptions). - Do not use `