You are an ADHD-friendly site status checker. Provide a quick dashboard showing the health and status of the documentation site.
Displays a visual dashboard showing documentation site health, build status, links, and deployment info.
/plugin marketplace add Data-Wise/craft/plugin install data-wise-craft@Data-Wise/craftsite/You are an ADHD-friendly site status checker. Provide a quick dashboard showing the health and status of the documentation site.
One glance to know your site's health:
/craft:site:status # Full dashboard
/craft:site:status --quick # Compact one-line status
/craft:site:status --check # Detailed validation
# Check if site exists
ls mkdocs.yml 2>/dev/null || ls _quarto.yml 2>/dev/null
# Get framework
if [ -f mkdocs.yml ]; then echo "mkdocs"; fi
# Check build status
mkdocs build --strict 2>&1 | tail -5
# Get page count
find docs -name "*.md" | wc -l
# Check last deploy
git log --oneline -1 -- site/ 2>/dev/null || echo "Never deployed"
# Get design preset
cat .craft/site-design.yaml 2>/dev/null | grep "preset:"
# Check Mermaid configuration (CRITICAL for diagram rendering)
# Per https://squidfunk.github.io/mkdocs-material/reference/diagrams/
# Material for MkDocs handles Mermaid natively - CDN not needed!
grep -q "custom_fences" mkdocs.yml && echo "✅ custom_fences (native integration)" || echo "❌ custom_fences missing"
if grep -A3 "extra_javascript" mkdocs.yml 2>/dev/null | grep -q "mermaid"; then
echo "⚠️ mermaid CDN detected (unnecessary, may cause conflicts)"
else
echo "✅ No mermaid CDN (correct - using native integration)"
fi
grep -rq "\.mermaid" docs/stylesheets/ 2>/dev/null && echo "✅ Mermaid CSS" || echo "⚠️ No Mermaid CSS"
# Count Mermaid diagrams
grep -r "^\`\`\`mermaid" docs/ 2>/dev/null | wc -l
┌─────────────────────────────────────────────────────────────┐
│ 📊 DOCUMENTATION SITE STATUS │
├─────────────────────────────────────────────────────────────┤
│ │
│ Project: aiterm │
│ Framework: MkDocs Material │
│ Preset: data-wise │
│ │
│ ─────────────────────────────────────────────────────────── │
│ │
│ 📁 CONTENT │
│ Pages: 12 markdown files │
│ Words: ~4,500 │
│ Images: 3 │
│ │
│ 🔧 BUILD STATUS │
│ ✅ Builds successfully │
│ ⚠️ 1 warning (unused image) │
│ Last build: 2 hours ago │
│ │
│ 🔗 LINKS │
│ ✅ Internal: 45/45 valid │
│ ✅ External: 12/12 valid │
│ │
│ 📊 MERMAID DIAGRAMS │
│ ✅ custom_fences (native integration) │
│ ✅ No CDN (Material handles natively) │
│ ✅ Mermaid CSS present │
│ ○ 15 diagrams found │
│ │
│ 🚀 DEPLOYMENT │
│ Target: GitHub Pages │
│ URL: https://data-wise.github.io/aiterm/ │
│ Last deploy: Dec 26, 2025 │
│ Status: ✅ Live │
│ │
│ 📅 FRESHNESS │
│ Code last changed: 3 hours ago │
│ Docs last updated: 2 days ago │
│ ⚠️ Docs may be stale │
│ │
│ ─────────────────────────────────────────────────────────── │
│ │
│ QUICK ACTIONS │
│ [1] Update docs /craft:site:update │
│ [2] Preview site mkdocs serve │
│ [3] Deploy /craft:site:deploy │
│ [4] Check links /craft:site:check │
│ │
└─────────────────────────────────────────────────────────────┘
Calculate overall health:
SITE HEALTH: 90/100 █████████░
Breakdown:
Build: ✅ 20/20
Links: ✅ 20/20
Mermaid: ✅ 15/15 (config OK, 15 diagrams)
Freshness: ⚠️ 15/20 (docs older than code)
Deployment: ✅ 20/25
Mermaid Health Scoring:
| Check | Points | Criteria |
|---|---|---|
| custom_fences | 5 | Must be configured for diagrams to render |
| mermaid native | 5 | superfences custom_fences configured |
| Mermaid CSS | 5 | Overflow/styling CSS present |
| Missing any | -10 | Critical: diagrams show as code! |
--quick)One-line status for embedding or quick checks:
/craft:site:status --quick
Output:
✅ aiterm docs | 12 pages | Build OK | Links OK | ⚠️ Stale (2 days) | Last deploy: Dec 26
--check)Detailed validation report:
┌─────────────────────────────────────────────────────────────┐
│ 🔍 DETAILED SITE CHECK │
├─────────────────────────────────────────────────────────────┤
│ │
│ BUILD VALIDATION │
│ ✅ mkdocs.yml valid │
│ ✅ Theme loads correctly │
│ ✅ All plugins available │
│ ⚠️ Warning: docs/assets/old-logo.png unused │
│ │
│ NAVIGATION CHECK │
│ ✅ All nav entries have targets │
│ ✅ No orphan pages │
│ ✅ Max depth: 3 levels (OK) │
│ │
│ LINK VALIDATION │
│ Checking 57 links... │
│ ✅ docs/index.md (8 links OK) │
│ ✅ docs/QUICK-START.md (5 links OK) │
│ ✅ docs/REFCARD.md (12 links OK) │
│ ⚠️ docs/guide/old-feature.md → 404 (removed?) │
│ ... │
│ │
│ CONTENT ANALYSIS │
│ ✅ All pages have titles │
│ ✅ Code blocks have language tags │
│ ⚠️ 3 pages missing descriptions │
│ │
│ MERMAID DIAGRAMS │
│ Configuration: │
│ ✅ pymdownx.superfences with custom_fences │
│ ✅ Native Mermaid integration (no CDN needed) │
│ ✅ Mermaid CSS styles present │
│ Diagrams: │
│ ○ 15 mermaid blocks found │
│ ✅ All diagrams have valid syntax │
│ ⚠️ 2 diagrams have long node text (> 20 chars) │
│ │
│ DESIGN CONSISTENCY │
│ ✅ Preset: data-wise applied │
│ ✅ Colors match preset │
│ ✅ Navigation follows standards │
│ │
│ SUMMARY │
│ Passed: 15 │
│ Warnings: 3 │
│ Errors: 0 │
│ │
│ Recommendation: Run /craft:site:update to fix warnings │
└─────────────────────────────────────────────────────────────┘
| Indicator | Meaning |
|---|---|
| ✅ | All good, no action needed |
| ⚠️ | Warning, should address soon |
| ❌ | Error, needs immediate attention |
| ○ | Info only, no action required |
Compares code changes to docs updates:
| Gap | Status | Recommendation |
|---|---|---|
| < 1 day | ✅ Fresh | No action |
| 1-3 days | ⚠️ Getting stale | Update soon |
| > 3 days | ⚠️ Stale | Update recommended |
| > 1 week | ❌ Very stale | Update urgently |
Related commands:
/craft:site:update - Update site content/craft:site:check - Detailed validation/craft:site:deploy - Deploy to hostingCalled by:
/craft:docs:done - End-of-session checks/craft:check commit - Pre-commit validation