Skip to content

docs: add animated GIF demos to README#1130

Open
srinidhi-2006-bit wants to merge 5 commits into
Priyanshu-byte-coder:mainfrom
srinidhi-2006-bit:docs/readme-gif-demos
Open

docs: add animated GIF demos to README#1130
srinidhi-2006-bit wants to merge 5 commits into
Priyanshu-byte-coder:mainfrom
srinidhi-2006-bit:docs/readme-gif-demos

Conversation

@srinidhi-2006-bit
Copy link
Copy Markdown
Contributor

Summary

Added animated GIF demos to the README to visually showcase the DevTrack UI and interactions.

Closes #1059

Type of Change

  • Documentation update

Changes Made

  • Added dashboard walkthrough GIF
  • Added UI interactions GIF
  • Updated README demo section with accessible alt text

How to Test

  1. Open README.md
  2. Verify both GIFs render correctly
  3. Confirm assets load from public/assets/gifs

Checklist

  • Linked issue in summary
  • Self-reviewed the diff

@vercel
Copy link
Copy Markdown

vercel Bot commented May 25, 2026

@srinidhi-2006-bit is attempting to deploy a commit to the PRIYANSHU DOSHI's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added gssoc26 GSSoC 2026 contribution type:docs GSSoC type bonus: documentation (+5 pts) type:feature GSSoC type bonus: new feature labels May 25, 2026
@github-actions
Copy link
Copy Markdown

GSSoC Label Checklist 🏷️

@Priyanshu-byte-coder — please apply the appropriate labels before merging:

Difficulty (pick one):

  • level:beginner — 20 pts
  • level:intermediate — 35 pts
  • level:advanced — 55 pts
  • level:critical — 80 pts

Quality (optional):

  • quality:clean — ×1.2 multiplier
  • quality:exceptional — ×1.5 multiplier

Validation (required to score):

  • gssoc:approved — counts for points
  • gssoc:invalid / gssoc:spam / gssoc:ai-slop — does not score

Type labels (type:*) are auto-detected from files and title. Review and adjust if needed.
Points formula: (difficulty × quality_multiplier) + type_bonus

@srinidhi-2006-bit
Copy link
Copy Markdown
Contributor Author

Thanks for reviewing the PR.

The failing Playwright smoke test appears to be unrelated to the README/GIF documentation changes in this PR, since build, lint, and type-check are all passing successfully.

The PR only adds README demo GIFs and static assets without modifying application logic or E2E flows.

@Priyanshu-byte-coder Priyanshu-byte-coder added level:beginner GSSoC: Beginner difficulty (20 pts) gssoc:approved GSSoC: PR approved for scoring labels May 26, 2026
@Priyanshu-byte-coder
Copy link
Copy Markdown
Owner

Playwright smoke tests are failing on this PR. Check the CI logs, fix failing tests, then push an update. Cannot merge while tests are red.

@Priyanshu-byte-coder
Copy link
Copy Markdown
Owner

Playwright smoke tests are failing on this PR. Please check the E2E test failures and fix them before merging.

@srinidhi-2006-bit
Copy link
Copy Markdown
Contributor Author

The failing Playwright smoke tests appear to be unrelated to this documentation-only PR.

I verified locally that:

  • npm run lint passes
  • npm run type-check passes
  • npm run build passes

The current E2E failures are caused by outdated Playwright assertions expecting older DevTrack UI/routes/components (dashboard redirects, landing page headings, footer elements, etc.), not by the README/GIF documentation changes introduced in this PR.

@Priyanshu-byte-coder
Copy link
Copy Markdown
Owner

CI is failing on this PR. Please fix the failing checks before this can be merged.

@srinidhi-2006-bit
Copy link
Copy Markdown
Contributor Author

done

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

gssoc:approved GSSoC: PR approved for scoring gssoc26 GSSoC 2026 contribution level:beginner GSSoC: Beginner difficulty (20 pts) type:docs GSSoC type bonus: documentation (+5 pts) type:feature GSSoC type bonus: new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: create video walkthrough / GIF demos for README

2 participants