# starlifter-docs-qa

> Quality-check Starlifter docs for broken links, missing sidebar entries, asset paths, and consistency after edits.

- Author: coxylox
- Repository: superstarlifter/doc
- Version: 20260126151542
- Stars: 0
- Forks: 0
- Last Updated: 2026-02-07
- Source: https://github.com/superstarlifter/doc
- Web: https://mule.run/skillshub/@@superstarlifter/doc~starlifter-docs-qa:20260126151542

---

---
name: starlifter-docs-qa
description: Quality-check Starlifter docs for broken links, missing sidebar entries, asset paths, and consistency after edits.
---

# Starlifter Docs QA

## When to use
- After content edits, renames, or page moves.
- Before publishing large doc changes.

## Checks
- **Links**: verify relative links resolve and include `.md`.
- **Sidebar**: ensure new or renamed pages appear in `docs/_sidebar.md`.
- **Assets**: confirm images live in `docs/assets/` and paths are relative.
- **Terminology**: use `starlifter-docs-author/references/terminology.md`.
- **Consistency**: headings in sentence case; steps are action-first.

## Quick command
```bash
python scripts/docs_qa.py
```

## Optional fix
```bash
python scripts/docs_qa.py --fix
```

## Check-only mode
```bash
python scripts/docs_qa.py --fix --check-only
```

## Output
- Report issues with file paths and proposed fixes.
- Apply fixes if safe; otherwise ask for clarification.
- Exit codes: `0` no issues, `1` issues found, `3` fixes applied (re-run to confirm).