Skip to content

Fix: clarify README app entry note#24

Draft
ishaan-jaff wants to merge 2 commits into
mainfrom
cursor/clarify-readme-note-6790
Draft

Fix: clarify README app entry note#24
ishaan-jaff wants to merge 2 commits into
mainfrom
cursor/clarify-readme-note-6790

Conversation

@ishaan-jaff
Copy link
Copy Markdown
Collaborator

@ishaan-jaff ishaan-jaff commented May 5, 2026

Summary

The README implied App.svelte is always the only file contributors need to edit, which is unclear for changes touching other files. This updates the note to describe App.svelte as the main app code location instead.

Repro

On main, run:

python3 - <<'PY'
from pathlib import Path
readme = Path('README.md').read_text()
if '](' in readme and 'contains the main app code.' in readme:
    print('PASS: README clearly describes App.svelte.')
else:
    print('FAIL: README still says App.svelte is all you need to edit.')
    raise SystemExit(1)
PY

It fails because the README says App.svelte "is all you need to edit."

Evidence

before
after

Tests

  • python3 scripts/verify-readme.py — passed
  • npm run build — not run: npm is not installed in this cloud image (--: line 1: npm: command not found)
Open in Web Open in Cursor 

cursoragent and others added 2 commits May 5, 2026 22:44
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
Co-authored-by: Ishaan Jaff <ishaan-jaff@users.noreply.github.com>
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