Instalar com Codex ou Claude Copie este prompt, cole no Codex, Claude ou outro assistente e deixe que ele revise a página da skill e instale para você.
Um comando direto ignora o prompt de revisão. Verifique a origem antes de executá-lo.
{"date":"2025-11-30T00:00:00.000Z","migrated_count":2,"migrated_location":"builder-skill-uvscript","reason":"UV script consolidation with unified builder-skill_ prefix","remaining_scripts":3}
last_updated
"2025-11-30T00:00:00.000Z"
compliance_score
61
auto_trigger_keywords
["docs","workflow"]
scripts
[{"name":"extract_mermaid_details.py","purpose":"Mermaid diagram detail extraction and rendering test guide generation","type":"python","command":"uv run .claude/skills/moai-workflow-docs/scripts/extract_mermaid_details.py","zero_context":false,"version":"1.0.0","last_updated":"2025-11-30T00:00:00.000Z"},{"name":"generate_final_comprehensive_report.py","purpose":"Phase 4: Generate final comprehensive validation report","type":"python","command":"uv run .claude/skills/moai-workflow-docs/scripts/generate_final_comprehensive_report.py","zero_context":false,"version":"1.0.0","last_updated":"2025-11-30T00:00:00.000Z"},{"name":"validate_korean_typography.py","purpose":"Korean-specific validation script (Phase 3)","type":"python","command":"uv run .claude/skills/moai-workflow-docs/scripts/validate_korean_typography.py","zero_context":false,"version":"1.0.0","last_updated":"2025-11-30T00:00:00.000Z"}]
color
red
⚠️ Partial UV Script Migration Notice
2 of 5 UV CLI scripts have been consolidated into the builder-skill-uvscript skill on 2025-11-30.
# Extract from code comments and type hintsdefgenerate_api_docs(source_files):
1. Parse docstrings and annotations
2. Generate markdown tables for parameters/returns
3. Include code examples from tests
4. Cross-reference related endpoints
5. Validate all links and references
Pattern 3: Documentation Sync
Detect code changes via git diff
Identify affected documentation sections
Update docs automatically or prompt for review
Validate documentation completeness
Generate changelog entries
Available Scripts
scripts/lint_korean_docs.py
When to use: Validate Korean markdown documentation before committing
Quick start:uv run .claude/skills/moai-workflow-docs/scripts/lint_korean_docs.py --help
When to use: Check Mermaid diagram syntax before committing documentation
Quick start:uv run .claude/skills/moai-workflow-docs/scripts/validate_mermaid_diagrams.py --help
When to use: Validate Korean typography rules and encoding
Quick start:uv run .claude/skills/moai-workflow-docs/scripts/validate_korean_typography.py --help
scripts/extract_mermaid_details.py
When to use: Extract Mermaid diagrams for detailed review
Quick start:uv run .claude/skills/moai-workflow-docs/scripts/extract_mermaid_details.py --help
scripts/generate_final_comprehensive_report.py
When to use: Generate aggregated validation report
Quick start:uv run .claude/skills/moai-workflow-docs/scripts/generate_final_comprehensive_report.py --help
📚 Core Patterns (5-10 minutes)
Pattern 1: Documentation Validation Pipeline
Key Concept: Run validation scripts in sequence to catch multiple error types
Pipeline Flow:
Run markdown linting on documentation files
Validate all Mermaid diagrams for syntax
Extract Mermaid diagrams for review
Check Korean typography (if applicable)
Generate comprehensive report
Basic Execution:
# Run complete validation
uv run .claude/skills/moai-workflow-docs/scripts/lint_korean_docs.py --help
uv run .claude/skills/moai-workflow-docs/scripts/lint_korean_docs.py --input docs/
uv run .claude/skills/moai-workflow-docs/scripts/lint_korean_docs.py --input docs/ --json
Pattern 2: Markdown Structure Validation
Key Concept: Ensure consistent markdown structure and formatting
Common Validations:
Headers: H1 unique, proper nesting (H1→H2→H3)
Code blocks: Language declared, matching delimiters