README: short, human, indexed; deep dives to docs/#1
Merged
Conversation
- README 320 → 114 lines with an Index section. Keeps: what it is, demo strip, install (two paths, brief), first video, Let Claude direct, pipeline diagram, template browsing, and a Going-deeper doc table. - Cut from README (single-source rule): full script.md grammar and the scene-template key table (owned by `videoeditor guide` and the `templates`/`preview` catalog), the crate map (owned by CLAUDE.md), and all nix depth. - New docs/nix.md owns the nix story: determinism/browser pinning rationale, every run variant, dev shell + CDP-client sharing, packaging & releases. - CLAUDE.md stays the agent/contributor ops manual; now points at docs/nix.md for depth. No content shared between README and CLAUDE.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
1 participant
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.
Per Dario's direction: README and CLAUDE.md must not duplicate each other, README stays short and human, and gets a proper index.
What moved where
videoeditor guide(embedded)videoeditor templates/preview(self-describing)README: 320 → 114 lines. Structure: tagline + demo strip → Index → Install → Your first video → Let Claude direct → How it works → Templates → Going deeper (doc table).
🤖 Generated with Claude Code