AnkTechsol / AnkTechsol/Satya_AI
[good first issue] Add screenshots and GIFs to README showcasing Satya AI dashboard
- Dominant language
- Python
- Stars
- 8
- Forks
- 6
- PR merge metrics
- No merged PRs in 30d
Description
## Task
Visual content is one of the most effective ways to attract stars and new contributors to a GitHub repository. The README needs screenshots and animated GIFs showcasing the Satya AI dashboard in action.
## What to Include
1. **Dashboard Overview** - A screenshot of the main Streamlit dashboard showing agent registration and task tracking
2. **Agent Workflow** - A GIF showing an AI agent being created, assigned a task, and logging progress
3. **Multi-Agent View** - A screenshot of the multi-agent collaboration interface
4. **Audit Log** - A screenshot of the audit log querying interface
5. **Settings Panel** - A screenshot of the configuration/settings area
## Implementation Steps
- [ ] Take high-quality screenshots of the dashboard (1920x1080 or similar)
- [ ] Record short screen capture GIFs (5-10 seconds) for key workflows
- [ ] Optimize images for web (compress with tools like TinyPNG or Squoosh)
- [ ] Add the images to an `assets/` or `docs/` directory
- [ ] Update the README.md to embed the screenshots and GIFs in the Features section
- [ ] Ensure images have descriptive alt text for accessibility
## Tips
- Use tools like Loom, ScreenToGif, or OBS to record GIFs
- Keep GIF file sizes under 2MB for fast loading
- Add captions under each screenshot explaining what it shows
- Consider adding a hero image at the top of the README
## Resources
- [Streamlit dashboard code](app.py)
- [GitHub Markdown image guide](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#images)
- [Awesome README](https://github.com/matiassingers/awesome-readme) for inspiration
---
**New to the project?** Check out our [Contributing Guide](CONTRIBUTING.md) to get started.
**Love Satya?** Please [give us a star](https://github.com/AnkTechsol/Satya_AI) to support the project!
Contributor guide
Assessment
This issue has not been assessed yet.