Improve README header and add dev smoke test#45
Conversation
📝 WalkthroughWalkthroughThe changes enhance the README with improved visual presentation through a centered HTML layout, larger header icon (160x160), and new TypeScript/HTML/CSS shields. A new "Quick local dev test" section documents the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 132-139: The README mentions the local dev test command bun run
dev:test but the "Useful scripts" index omits it; update the README's "Useful
scripts" list to include an entry for dev:test (with a short description like
"fast local sanity check: typecheck, unit tests, Firefox build") so the command
is discoverable, ensuring the script name dev:test matches the example shown
earlier.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: 01cfd8c5-c490-464a-9f7c-b6d6fade1659
📒 Files selected for processing (2)
README.mdpackage.json
| ### Quick local dev test | ||
|
|
||
| ```bash | ||
| bun run dev:test | ||
| ``` | ||
|
|
||
| Runs a fast local sanity check without Docker: typecheck, unit tests, and a Firefox build. | ||
|
|
There was a problem hiding this comment.
Keep script docs consistent with the command index.
Line [135] introduces bun run dev:test, but the later Useful scripts list doesn’t include it, which can cause discoverability drift.
📌 Suggested README update
- `bun run typecheck`
- `bun run test`
+- `bun run dev:test`
- `bun run test:watch`🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 132 - 139, The README mentions the local dev test
command bun run dev:test but the "Useful scripts" index omits it; update the
README's "Useful scripts" list to include an entry for dev:test (with a short
description like "fast local sanity check: typecheck, unit tests, Firefox
build") so the command is discoverable, ensuring the script name dev:test
matches the example shown earlier.
Summary
bun run dev:testsmoke check for local developmentSummary by CodeRabbit
Documentation
Chores
dev:testscript for running type check, tests, and build verification in sequence.