Skip to content

DOCS UPDATE: Enhance README with visual GIFs and improved navigation (PR ready)Β #130

@alizahh-7

Description

@alizahh-7

Is this related to an existing part of the documentation?

  • Yes, it is related to an existing section

What needs to be updated?

πŸ“Œ Current Documentation Issue

The current README is informative but primarily text-based, which can make it less engaging for first-time visitors and potential contributors. Additionally, long documentation without quick navigation back to the top can slightly affect readability and overall user experience.

✨ Proposed Changes

  • Added relevant and lightweight GIFs at suitable sections of the README to visually represent the project flow and improve engagement.
  • Ensured that all existing content and structure remain unchanged.
  • Added a Back to Top navigation link at the bottom of the README to improve usability for readers.
  • Focused on enhancing clarity, attractiveness, and contributor-friendliness without introducing any functional or code-level changes.

πŸ“‹ Additional Context

  • The changes are documentation-only and safe to merge.
  • A pull request has already been prepared with these updates.
  • These improvements aim to make the repository more welcoming, especially for new contributors and open-source program reviewers.

Relevant Documentation Link (if any)

No response

Record

  • I agree to follow this project's Code of Conduct
  • I want to work on this update

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions