Skip to content

[Docs] Replace Web UI preview with animated demo #35

Description

@realrazdev

Summary

Replace the static web-preview.png image in the README with an animated demo showcasing the Web UI.


Context

Context

The README currently uses a static screenshot (web-preview.png) to showcase the Web UI.

Replace it with a short animated demo (GIF preferred) to better demonstrate the interactive experience, including the AI Explain feature.

For setup and usage of the Explain feature, refer to USAGE.md. This issue only covers the README demo and should not duplicate existing documentation.


Requirements

  • Ensure Ollama is installed, running, and configured before recording the demo (see USAGE.md for setup instructions).
  • Replace the current web-preview.png in the README with an animated demo.
  • Record a short GIF (5–15 seconds preferred).
  • Demonstrate:
    • Opening the Web UI
    • Creating or selecting a task
    • Using the Explain feature
    • Switching between Summary, Deep Analysis, and Action Plan
  • Keep the demo concise and high quality.

Non-goals

  • Do not modify application code.
  • Do not update CLI documentation.
  • Do not duplicate information already documented in USAGE.md.

Acceptance Criteria

  • The static web-preview.png is replaced with an animated demo.
  • The demo showcases the Explain feature.
  • The README renders correctly on GitHub.
  • No application code changes are required.

What's next?

Thanks for contributing! We'd love to see another PR from you.

Looking for another task? Browse the open issues.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomershelp wantedExtra attention is needed

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions