Skip to content

## πŸ“„ [Documentation] Demo URL is a placeholder (your-bookcat-app.netlify.app) and all 5 screenshots use via.placeholder.com images β€” README does not represent the actual applicationΒ #117

Description

@prince-pokharna

Summary

The README's two most important sections for attracting contributors and users contain non-functional placeholder content:

Demo section:

**Live Demo:** https://your-bookcat-app.netlify.app
*(Replace with your actual deployed URL)*

The actual live app is at https://bookcatq.netlify.app/ (visible in the repo description) but the README still shows the placeholder template URL.

Screenshots section:
All 6 screenshot slots use via.placeholder.com placeholder images:

[![Dashboard](https://via.placeholder.com/600x360/1a1a2e/636bf1?text=Dashboard)]
[![Library](https://via.placeholder.com/600x360/1a1a2e/636bf1?text=Library)]

Why this matters:

  • The README is the first thing 11 forks and potential contributors see
  • Placeholder content signals an incomplete or unmaintained project
  • Contributors evaluating whether to contribute want to see what they're building
  • The README explicitly says "Replace the placeholders below with actual screenshots" β€” this has not been done

Proposed Fix

  1. Update the Demo URL to https://bookcatq.netlify.app/
  2. Take actual screenshots of the deployed app on the following pages:
    • Dashboard (reading progress, stats)
    • Library (book list with statuses)
    • Discover (mood search results)
    • Community (friend activity feed)
    • Stats (reading analytics)
  3. Upload screenshots to apps/web/src/assets/screenshots/ and link from README
  4. Remove the "Replace the placeholders" note from README

Acceptance Criteria

  • Demo URL updated to the actual Netlify deployment URL
  • All 5–6 README screenshots replaced with actual app screenshots
  • Screenshots stored in apps/web/src/assets/screenshots/ or a docs/screenshots/ directory
  • Placeholder template instructions removed from README

Labels: documentation, good first issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions