Skip to content

docs: add screenshots and visual previews to README#64

Open
Yashaswini-K-P wants to merge 2 commits into
codepvg:mainfrom
Yashaswini-K-P:docs/add-readme-screenshots
Open

docs: add screenshots and visual previews to README#64
Yashaswini-K-P wants to merge 2 commits into
codepvg:mainfrom
Yashaswini-K-P:docs/add-readme-screenshots

Conversation

@Yashaswini-K-P
Copy link
Copy Markdown
Contributor

Description

Adds screenshots and visual previews of the main pages in the application to improve README documentation and help users quickly understand the UI.

Linked Issue

Fixes #44

Changes Made

  • Added screenshots for:
    • Home Page
    • Registration Page
    • Leaderboard Page
  • Updated README to include a Screenshots section with image previews

Type of Change

  • Bug fix
  • New feature
  • UI/Visual update
  • Documentation update
  • Refactor

Testing

  • Tested locally
  • Tested on mobile viewport (if applicable)
  • No console errors introduced

Checklist

  • My code follows the project's coding style
  • I have formatted my code locally using Prettier
  • I have performed a self-review of my code
  • My changes generate no new warnings or errors
  • I have updated documentation if required
  • I have linked the relevant issue

Comment thread README.md
Comment on lines +21 to +23
## Screenshots

### Home Page
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Screenshots
### Home Page
## Screenshots
A quick preview of the platform UI. The appearance may evolve as the project develops.
### Home Page

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add screenshots and demo previews to README

2 participants