What it proves
A narrow check can be more reusable than a broader reviewer when it points directly at the blockers most likely to stop a draft from shipping cleanly.
Workflow checks
doc-ship-check is the clearest example of a last-mile workflow check staying focused on publish blockers.
This guide exists because the repo shows a useful standard for workflow checks: catch the few issues that reliably slow review, handoff, or publishing instead of turning the tool into a vague writing assistant.
Why this repo carries the track
A short site-side guide before the proof layer on GitHub.
Why it matters in this track
It expands the workflow-check idea beyond repo onboarding: repeated cleanup work can be turned into a rerunnable pass that shortens the finish instead of adding another review thread.
What survives the first run
The issue list is the artifact. It gives you a compact repair list you can clear before review or handoff.
What the first useful success looks like
doc-ship-check as a first useful success, not only a demo.
The first useful run is a short list of fixable publish blockers. That is enough to turn the tool from a concept into a practical finish-line check for Markdown-heavy work.
Use this before publishing docs, before asking another team to review a draft, or anywhere the last pass keeps surfacing the same cleanup issues.
python3 doc_ship_check.py tests/fixtures/docs- tests/fixtures/docs/bad/readme.md: placeholder text 'TODO'
- tests/fixtures/docs/bad/readme.md: broken relative link 'missing.md'
- tests/fixtures/docs/bad/readme.md: placeholder text 'ADD TEXT'
- tests/fixtures/docs/bad/readme.md: duplicate heading '# bad doc'Where it routes next
Final-pass Markdown checker for placeholders, broken links, and duplicate headings.