القائمة
Run quality assurance checks on Waldur documentation. Use before committing changes or when validating the build.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Generate or regenerate Waldur changelog entries. Use for release documentation or fixing changelog issues.
Add new documentation to Waldur docs. Use when creating new markdown files, adding guides, or documenting features.
Generate llms.txt and llms-full.txt files for LLM-friendly documentation access.
Sync documentation from external Waldur repositories. Use when updating externally-sourced docs or checking sync status.
| name | quality-check |
| description | Run quality assurance checks on Waldur documentation. Use before committing changes or when validating the build. |
| allowed-tools | Bash(poetry:*), Bash(node:*), Bash(python:*) |
Run these checks before committing any documentation changes.
# Lint markdown files
node lint-markdown.mjs
# Build with strict validation (catches broken links, missing files)
poetry run mkdocs build --strict
# 1. Lint markdown
node lint-markdown.mjs
# 2. Generate llms-full.txt
python3 scripts/generate-llms-txt.py
# 3. Strict build
poetry run mkdocs build --strict
# 4. Validate external sync (if external sources modified)
python scripts/validate-external-sync.py
# Start development server at http://127.0.0.1:8000
poetry run mkdocs serve
The lint-markdown.mjs script enforces:
| Rule | Setting | Reason |
|---|---|---|
| MD013 (line length) | Disabled | Documentation has flexible line lengths |
| MD007 (list indent) | Disabled | Flexible indentation allowed |
| MD033 (inline HTML) | Disabled | HTML needed for advanced formatting |
| MD012 (blank lines) | Disabled | Multiple blank lines permitted |
../admin-guide/deployment/helm/img/ directories.pages navigation references valid files<!-- EXTERNAL DOCUMENT --> cannot be edited locally/sync-external skill for external content