Skip to content

docs: honest privacy wording, prerequisites, Next.js badge, troubleshooting page - #1839

Merged
magic-peach merged 1 commit into
mainfrom
docs/readme-review-fixes
Nov 4, 2026
Merged

magic-peach merged 1 commit into
mainfrom
docs/readme-review-fixes

Conversation

@magic-peach

@magic-peach magic-peach commented Nov 4, 2026 •

Copy link
Copy Markdown
Collaborator

Phase 2 additions, from your review of the README. Most points were already fixed by the rewrite in #1833 (merged). This PR does the rest. Status of each point against the README now on main:

Point Status
Remove "No tracking" / "100% private"; honest wording with the opt-out; no offline claim Already gone from README, docs and the app UI. This PR: the tagline said "Nothing is uploaded", which overstates it now that anonymous analytics are sent. It now says "Your video never leaves your device" (also in docs/USAGE.md). The Privacy section has your wording, with the Settings opt-out.
Live site near the top with a screenshot/GIF placeholder Already there (live link and docs/assets/demo-placeholder.svg).
CI badge magic-peach → reframe-oss Already reframe-oss/reframe.
Next.js badge (16) Added (Next.js 16).
Prerequisites: Node 20.9+ with Bun Added to the README quick start and to CONTRIBUTING.
LICENSE link after the rename Already LICENSE (renamed in #1833).
Netlify deploy note (COOP/COEP via netlify.toml, not "CORS") Already correct in docs/DEPLOYMENT.md; the old note is gone.
Privacy paragraph rendering as a heading; stranded "Outputs a static site" line; duplicate Vercel sections; duplicate Built With badges All gone in the rewrite.
GSSoC: no "add the label yourself", a real count or none, link to /assign, GSSoC logo No self-labelling and no count. This PR: explains claiming with /assign, links how it works, and says maintainers add labels. The logo is still the placeholder from #1833 until you add the official file.
Snyk under "Supported by" Already there, next to Netlify, Datadog and Chromatic.
Troubleshooting: don't delete bun.lock; use bun install --frozen-lockfile and report the error; move Troubleshooting/FAQ to docs/ New docs/TROUBLESHOOTING.md, linked from the README quick start. It says never to delete bun.lock, to run --frozen-lockfile and report the full error, and covers the frozen-lockfile message, env vars, the single-threaded engine in bun run dev, stalled exports, and the FAQ.
contrib.rocks &max=500 Already there.
CODE_OF_CONDUCT.md line 39 [INSERT CONTACT METHOD] Replaced in #1833 with a visible TODO and an interim route (GitHub's report-abuse form). TODO for you: a contact email for conduct reports. I haven't invented one. SECURITY.md has the same placeholder ([maintainer email]).

Also: a code comment in DatadogInit.tsx called Reframe "100% private"; it now gives the real reason replay is off.

No code behaviour changes.

…ooting page

- README tagline says the video never leaves the device (anonymous
  analytics are sent, so "nothing is uploaded" overstated it); same in
  docs/USAGE.md.
- Next.js 16 badge; prerequisites: Bun 1.x and Node.js 20.9+ (README,
  CONTRIBUTING).
- GSSoC section explains /assign and that maintainers add labels.
- docs/TROUBLESHOOTING.md (the old README's Troubleshooting/FAQ, updated):
  bun install --frozen-lockfile and report the error, never delete bun.lock;
  linked from the README.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@netlify

netlify Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for reframe-os ready!

Name Link
🔨 Latest commit 5c4c517
🔍 Latest deploy log https://app.netlify.com/projects/reframe-os/deploys/6aeabecd32a32e4106087224
😎 Deploy Preview https://deploy-preview-1839--reframe-os.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions Bot added level:intermediate Intermediate level - 35 pts type:bug Bug fix type:design UI/UX design labels Nov 4, 2026
@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

👋 Thanks for your PR, @magic-peach!

Welcome to Reframe — a browser-based video editor built for everyone 🎬

🟠 GSSoC'26 PR detected — thanks for contributing under GirlScript Summer of Code 2026!

What happens next

  1. 🤖 Automated checks — build & TypeScript typecheck will run automatically
  2. ✅ Vercel preview — a preview deployment will be created (requires maintainer authorization for fork PRs)
  3. 👀 Code review — a maintainer will review your changes
  4. 🚀 Merge — once approved, your PR will be merged!

Quick checklist

  • PR title follows Conventional Commits (e.g. feat: add dark mode)
  • Linked the issue this PR closes (e.g. Closes #123)
  • Tested the changes locally (bun run dev)
  • Build passes (bun run build)

Useful links

Happy coding! 🎉

@github-actions github-actions Bot added type:docs Documentation type:security Security labels Nov 4, 2026
@github-actions

github-actions Bot commented Nov 4, 2026

Copy link
Copy Markdown
Contributor

⚠️ PR Format Issues — @magic-peach

Please fix the following before your PR can be reviewed:

  • ⚠️ No linked issue found. Add Closes #<issue-number> to your PR description.

Push new commits after fixing — this comment will update automatically.

📖 CONTRIBUTING.md

@github-actions github-actions Bot added the gssoc'26 GirlScript Summer of Code 2026 label Nov 4, 2026
@magic-peach
magic-peach marked this pull request as ready for review November 4, 2026 05:48
@magic-peach
magic-peach merged commit fda34f0 into main Nov 4, 2026
23 of 27 checks passed
@github-actions

github-actions Bot commented Nov 4, 2026 •

Copy link
Copy Markdown
Contributor

Claude encountered an error —— View job


I'll analyze this and get back to you.

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

Labels

gssoc'26 GirlScript Summer of Code 2026 level:intermediate Intermediate level - 35 pts type:bug Bug fix type:design UI/UX design type:docs Documentation type:security Security

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant