Needs fix

xword-pipeline

github-repo

Dense NYT-style crossword puzzle pipeline: Rust fill-engine + Claude clue writer/QA/explain process

by Erik 2y account · 2 repos·★ 1 · Custom · pushed yesterday· github.com ·audited by @Erik
8/12
checks passing

No blockers — but 3 fixes would strengthen the launch.

Sign in to re-audit Re-audits need a free account. All audits of this project →

Fix before launch 3

#5 Install / try-it path early Fix before launch

install command buried at char 1445 of README (target: <300)

Do this

Move the install command above the table of contents. Convention: intro paragraph → install command → quickstart.

Why we flagged this

Most readers skim the first paragraph and decide whether to engage. Burying the install command below intro / badges / table-of-contents means readers don't see how to try it.

#6 Hero visual present Fix before launch

No demo GIF or screenshot in the first quarter of the README

Do this

Record a 10-30s demo GIF (vhs, asciinema, peek, ScreenToGif) showing the project doing its thing. Embed near the top of the README.

Why we flagged this

Readers grok visual demos in 2 seconds; they grok prose descriptions in 30. A demo GIF is the highest-ROI thing you can add.

#14 Alternatives substance Fix before launch

No alternatives provided (FuzzPage submission form field required)

Do this

Pick 1-3 similar tools. For each: write one sentence on the specific axis of difference (speed, scope, pricing, target user, technical approach).

Why we flagged this

Naming 1-3 alternatives with a one-line differentiator each forces honest positioning and creates a discovery graph for readers.

Polish 1

#11 Roadmap / updates surface Polish

No roadmap, changelog, or 'what's next' section found

Do this

Add a `## Roadmap` or `## Changelog` section to your README, even briefly.

Why we flagged this

Visitors evaluating a new project look for signals it will be maintained. A roadmap shows momentum; a changelog shows history; either reduces 'dead-on-arrival' anxiety.

Passing 8
Skipped — not applicable 3