Skip to content

[BUG] Improve Documentation with Setup Instructions & Preview GIFs. #788

@ReshmithaTc

Description

@ReshmithaTc

Description:

The current README lacks detailed setup instructions and does not show visual previews of components. This makes it harder for newcomers to get started quickly.

Proposed Solution:

  • Add a “Getting Started” section with setup steps (clone repo, open index.html, contribute).
  • Add GIFs/screenshots of a few animations/templates for quick preview.
  • Include a Contributing Guide link for first-time contributors.

Benefits:

  • Helps beginners contribute easily.
  • Attracts more users to explore and use the project.

As a Contributor of GSSoc'25 , I would like to solve this issue. Could you please assign it to me @supriya46788

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions