Skip to content

Added Screenshots To README.md - #24

Open
AaritShrama wants to merge 1 commit into
LetsCook-Organization:mainfrom
AaritShrama:style/Add-Real-Screenshots-To-README
Open

AaritShrama wants to merge 1 commit into
LetsCook-Organization:mainfrom
AaritShrama:style/Add-Real-Screenshots-To-README

Conversation

@AaritShrama

Copy link
Copy Markdown

🌌 Pull Request Summary

Description

This PR improves the CodeOrbit README by adding real screenshots of the application, allowing users and potential contributors to better understand its features and interface before using it.

Changes introduced:

  • Added screenshots showcasing Study Sessions, Projects, Goals, and Progress Analytics.
  • Organized the four screenshots into a clean 2×2 gallery using GitHub-compatible HTML tables.
  • Added descriptive captions explaining each feature.
  • Made screenshots clickable to view them in full resolution.
  • Preserved all existing README content, formatting, and documentation.
  • No application functionality or source code was modified.

Type of Change

Select all that apply:

  • Bug fix (non-breaking change resolving an unexpected behavior or error)
  • New feature (non-breaking addition of a new capability or module)
  • UI / UX enhancement (visual design, accessibility, responsiveness, or theme polish)
  • Documentation (improvements to README, guides, architecture, or inline comments)
  • Refactoring (code structure improvement with no behavioral changes)
  • Performance optimization (reducing memory, canvas renders, or LocalStorage I/O)

How Has This Been Tested?

This is a documentation-only contribution. No application logic, browser storage, or functional components were modified.

  • Browser Testing: Verified manually in modern browser (Chrome, Edge, Firefox, or Safari)
  • Zero Console Errors: Confirmed DevTools console has zero unhandled exceptions or warnings
  • LocalStorage Integrity: Verified state saves and loads correctly without corrupting existing user data
  • Responsive Design: Checked layout at desktop (1440px), tablet (768px), and mobile (375px) breakpoints
  • Accessibility: Verified keyboard navigation (Tab, Escape, Ctrl+K) and semantic element readability

Documentation-specific verification:

  • Verified all four screenshots render correctly in the GitHub README preview.
  • Verified that clicking each screenshot opens the full-resolution image.
  • Confirmed that the PR modifies only README.md.
  • Confirmed that no application source code was modified.

Contributor Checklist

Before submitting, please ensure your PR satisfies:

  • My code adheres to the project's vanilla standards (HTML5, CSS3, ES6+ modules; zero heavy frontend frameworks or build steps).
  • I have read and followed the [Contributing Guidelines](https://github.com/LetsCook-Organization/CodeOrbit/blob/main/CONTRIBUTING.md).
  • I have performed a self-review of my own code.
  • I have preserved all existing unrelated code, docstrings, and comments.
  • Saved or typed text put into HTML goes through escapeHTML(), and links through safeUrl(), to prevent XSS. (Not applicable — no dynamic application HTML or JavaScript was changed.)
  • Words on screen are plain (no jargon), and stored values are shown through the label helpers (statusLabel, projectStatusLabel, typeLabel, skillLabel), not changed. (Not applicable — application UI and stored values were unchanged.)
  • If I added, removed or renamed a file the app loads, I updated APP_FILES in sw.js (and CACHE_VERSION for a removal or rename). (Not applicable — no application files were added, removed, or renamed.)
  • I have updated corresponding documentation if my changes modify existing features or settings. (Not applicable — no existing features or settings were modified.)
  • npm run check passes locally, or I have confirmed the CI check on this PR is green.
  • If this PR changes something users can see or do, I added a line under Unreleased in [CHANGELOG.md](https://github.com/LetsCook-Organization/CodeOrbit/blob/main/CHANGELOG.md). (Not applicable to application functionality — this PR updates README screenshots only.)
  • If this PR makes a design choice (new library, data-shape change, trade-off), I added an entry to [docs/DECISIONS.md](https://github.com/LetsCook-Organization/CodeOrbit/blob/main/docs/DECISIONS.md). (Not applicable — no architectural decisions were made.)
  • If this PR changes which function calls which, or the startup order, I updated [docs/FLOW.md](https://github.com/LetsCook-Organization/CodeOrbit/blob/main/docs/FLOW.md). (Not applicable — no application execution flow was modified.)

@AaritShrama

Copy link
Copy Markdown
Author

My submission for the issue i was allotted
#12

@abhishekgoswami0720

Copy link
Copy Markdown
Collaborator

Hey @AaritShrama, thanks for this! The 2x2 layout looks really nice, and putting it under "What you can do" actually works better than where I wrote in the issue.

Few things before I merge:

  • The images are uploaded as GitHub attachments right now. Can you add them as actual files in docs/screenshots/ (png or webp, under 300 KB, squoosh.app works well for compressing) and link them with relative paths? That way they stay with the repo.
  • Alt text should say what's on the screen, not just the page name. There's an example in docs/screenshots/README.md.
  • Can we use the same words as the app in the captions? Study sessions, Projects, Goals, Progress. "Project Management" and "Progress Analytics" sound a bit different from what users actually see. Also a simple "Screenshots" heading is enough, no need for the rocket title and tagline.
  • If possible, swap one of them for the Home page. That's the first thing people see when they open the app.

And just double check all 4 are with sample data, not your own.

Almost there, just push to the same branch and the PR will update.

This branch has not been deployed

No deployments
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.

2 participants