Repository navigation
docs: rewrite README; deployment, usage and contributing guides; credits - #1833
Merged
Merged
Conversation
- README: about 120 lines. Working badges for reframe-oss/reframe (stars, issues, license, CI on main, Netlify status, Snyk), the live demo link, a demo placeholder, features, how it works, quick start, privacy, contributing, GSSoC, "Supported by" with self-hosted light/dark logos, and contrib.rocks. Removes the fork badge, the duplicated Vercel sections and the "works offline after first load" claim (there is no service worker). - docs/DEPLOYMENT.md (Netlify first, cross-origin isolation explained), docs/USAGE.md (flow, keyboard shortcuts as the code defines them, what to do when an export is slow). - CONTRIBUTING.md rewritten: Bun setup, claiming with /assign, branch names, Conventional Commits, PR checklist (lint, typecheck, test, build), review, project rules, GSSoC notes. Folds in CONTRIUBUTION.md, which is removed. - CODE_OF_CONDUCT.md: the [INSERT CONTACT METHOD] placeholder becomes a visible TODO with a working interim route. - "MIT LICENSE" renamed to LICENSE (so GitHub detects it); PHASE_1_MVP.md moved to docs/history/. - all-contributors config and .github/ALL_CONTRIBUTORS.md with instructions; nobody is added automatically. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
✅ Deploy Preview for reframe-os ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
github-actions
Bot
added
level:advanced
Contributor
|
Contributor
👋 Thanks for your PR, @magic-peach!Welcome to Reframe — a browser-based video editor built for everyone 🎬
What happens next
Quick checklist
Useful links
Happy coding! 🎉 |
This was referenced Nov 3, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
magic-peach
marked this pull request as ready for review
November 3, 2026 16:32
Contributor
|
Claude encountered an error —— View job I'll analyze this and get back to you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Phase 2, part 1: docs and attribution. The code part (analytics opt-out, footer credits) is a separate PR.
Supersedes #1830: the live demo link is at the top of the new README.
What changes
reframe-oss/reframe: stars, issues, license, CI onmain, Netlify status, Snyk;docs/ARCHITECTURE.md) and a three-command quick start;<picture>light/dark logos served from this repo;max=500, and the license.docs/ARCHITECTURE.mdmade the same claim and is corrected too.Ctrl+Shift+E,I/O(set trim points from the playhead),R,1–9and?. It also explains what happens when an export is slow./assignand the bot's rules, branch prefixes, and Conventional Commits;CONTRIUBUTION.md(bug reports, feature requests, branch naming) are folded in, and that file is deleted.[INSERT CONTACT METHOD]. TODO for you: it now shows a visible TODO and an interim route (GitHub's report-abuse form, or tag @magic-peach on an issue). Please add a private contact address.SECURITY.mdalso still says[maintainer email].MIT LICENSE→LICENSE, so GitHub detects the license and the badge works.PHASE_1_MVP.md→docs/history/; the one link to it is updated..all-contributorsrc(empty list) and.github/ALL_CONTRIBUTORS.md, with instructions for crediting reviewers, mentors, designers and others through the bot or the CLI. Nobody is added automatically.Logos: please download the official files
No third-party image is hotlinked. Logos live in
docs/assets/brand/.netlify-light.svg,netlify-dark.svgpublic/badges/datadog-light.png,datadog-dark.pngpublic/badges/(2000×2000)snyk-light.svg,snyk-dark.svggssoc-light.svg,gssoc-dark.svgchromatic-light.svg,chromatic-dark.svgdocs/assets/demo-placeholder.svgdocs/assets/demo.gif(under 5 MB), with the README<img>pointed at itKeep the same file names and the README needs no changes. I kept Chromatic under "Supported by" even though your list named only Netlify, Snyk and Datadog, because it provides the visual review service; remove it if you prefer.
Stray root files: your decision
vercel.json: Netlify is the only host, butvercel.jsonstill mirrors the headers anddocs/DEPLOYMENT.mdmentions it for forks. Options: delete it (and the Vercel row and the comments innetlify.tomlandpublic/_headersthat reference it), or keep it as an unmaintained example.reframeis gone: it was a phantom submodule, removed in fix: remove phantom git submodule reference at path "reframe" #1765..snyk,.env.example,CHANGELOG.md,SECURITY.md,CLAUDE.md, and the configs.Notes
docs/DEPLOYMENT.mdandCONTRIBUTING.mdmentionscripts/serve-isolated.mjs,scripts/make-fixtures.shandbunx playwright test, which arrive with fix(export): unknown durations, stuck-progress watchdog, e2e export tests #1832. Merge that first, or these instructions point at files that don't exist yet.magic-peach/reframe; the code PR fixes it.