-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
Problem
The README is well-structured but buries the lead. We have a working live demo at https://checkst-bot.vercel.app but recruiters/visitors won't see it until they scroll down.
Solution
Add a prominent demo section at the very top of the README:
1. Add Demo Banner
# checkstBot - RAG-Powered Learning Assistant
[](https://checkst-bot.vercel.app)
[](https://www.typescriptlang.org/)
[](https://nextjs.org/)
> 🎓 **[Try the Live Demo →](https://checkst-bot.vercel.app)**
2. Create Screenshots
- Take screenshot of main interface with document uploaded
- Take screenshot showing RAG chat in action
- Optional: Create a GIF showing the workflow (upload → chat → response)
- Store in
/docs/or/public/folder
3. Add "Demo" Section After Features
## 🎬 Demo
See checkstBot in action:
| Upload Documents | Chat with AI | Get Contextual Answers |
|-----------------|--------------|----------------------|
|  |  |  |Impact
HIGH - Visual demo is the #1 thing that makes recruiters stop and look. Currently they have to imagine what it looks like.
Effort
~15 minutes to take screenshots and update README
Labels: enhancement, documentation, good first issue
Metadata
Metadata
Assignees
Labels
No labels