-
Notifications
You must be signed in to change notification settings - Fork 3.2k
web sourced footage, illustration engines, and layout qc for explainers #148
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
DonIsmaelito
wants to merge
24
commits into
browser-use:main
Choose a base branch
from
DonIsmaelito:feature/explainer-visual-tools
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
24 commits
Select commit
Hold shift + click to select a range
9df879e
add agents guidance pytest path and skill contract guard
DonIsmaelito 1312518
add plain language comments to helpers and tests
DonIsmaelito b27cd4f
add plain language comments to the original render helper
DonIsmaelito 70e6aa1
add comment convention guard test
DonIsmaelito f4bf4b4
add plain language comments to the orientation test
DonIsmaelito 2aca4bb
trim internal harness guidance out of the agent rules
DonIsmaelito 54199c0
use module docstrings instead of hash headers and guard that shape
DonIsmaelito 4f8ab2d
derive comment guard definitions from the ast and check bare helper n…
DonIsmaelito b48e603
require comment text above a definition instead of a bare hash
DonIsmaelito f3b48eb
add edl v2 contract deliverables overlay layouts preflight and substa…
DonIsmaelito 5e9674d
add plain language comments to the renderer edl validator and captions
DonIsmaelito 27ab866
add web sourcing illustration engines and layout qc tooling
DonIsmaelito 35d98cf
write the subtitle format name in capitals in comments
DonIsmaelito 2c554a3
add plain language comments to web sourcing illustration and layout q…
DonIsmaelito 9f5c5b3
remove harness wording from the edl validator and deliverables reference
DonIsmaelito e633f31
convert file headers to module docstrings
DonIsmaelito 3312259
name the substation subtitle helpers by the format name and use modul…
DonIsmaelito d6c45ec
describe deliverables footage sourcing and layout checks in the readme
DonIsmaelito 9a52ac4
reject non object and non finite edit inputs write captions as utf8 a…
DonIsmaelito 9fecb2f
gate downloads on kept selections reject non finite ranges and intern…
DonIsmaelito 090d595
reject duplicate outputs fractional versions and bad source ids skip …
DonIsmaelito 4b6b5be
remove third party diagram example from distribution
DonIsmaelito 36177fe
preserve legacy deliveries and reject invalid caption evidence
DonIsmaelito c8f9028
inherit reviewed delivery and caption protection
DonIsmaelito File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| # video-use repository context | ||
|
|
||
| video-use is a public, conversation-driven video production framework. Changes | ||
| made here may be packaged into the skill and reused by people with different | ||
| machines, media, workflows, providers, brands, and output goals. Treat the | ||
| repository as a general product, never as one person's customized clone. | ||
|
|
||
| ## Product principles | ||
|
|
||
| - The delivered video is the product. Prioritize visual and audio quality, | ||
| editorial judgment, factual correctness, synchronization, pacing, and | ||
| production reliability. | ||
| - Design reusable contracts and capabilities. Do not hardcode personal paths, | ||
| credentials, account ids, prompts, brands, preferences, or assumptions | ||
| about one project. | ||
| - Keep provider-specific behavior behind narrow boundaries. Core EDL validation, | ||
| rendering, reframing, and QC must remain usable from the command line without | ||
| any optional client or remote runner. | ||
| - Preserve backwards compatibility when practical. If a format must change, | ||
| provide a clear migration path and reject unsupported input with an actionable | ||
| error. | ||
| - Never silently downgrade a requested feature. A missing source, track, model, | ||
| codec, or dependency should fail before expensive work begins and explain what | ||
| is required. | ||
| - Defaults should be safe and broadly useful, while explicit project or user | ||
| requirements always win. | ||
| - Keep credentials out of source, logs, fixtures, prompts, and generated | ||
| artifacts. Configuration belongs in environment variables or provider secret | ||
| stores. | ||
|
|
||
| ## Architecture boundaries | ||
|
|
||
| - `SKILL.md` defines the agent workflow and public editing contract. | ||
| - `helpers/` contains provider-independent production tools and validation. | ||
| - `skills/` contains focused companion skills and reusable production assets. | ||
| - `tests/` protects public behavior. Optional clients or remote runners may | ||
| orchestrate core features but must never become the only place a feature | ||
| exists. | ||
|
|
||
| Keep decision data explicit in portable project files such as `edit/edl.json`. | ||
| Renderers should consume declared inputs deterministically. UI state, agent | ||
| history, and cloud runtime state must not be required to reproduce an output. | ||
|
|
||
| ## Change workflow | ||
|
|
||
| 1. Identify whether a change belongs to the public editing contract, a reusable | ||
| helper, a focused skill, or an optional adapter. | ||
| 2. Implement the smallest complete general capability at the lowest reusable | ||
| layer. Wire adapters to that capability instead of duplicating it. | ||
| 3. Validate inputs locally before uploads or paid compute. Validate again at | ||
| remote execution boundaries. | ||
| 4. Add tests for successful use, invalid input, backwards compatibility, and | ||
| provider-boundary behavior where relevant. | ||
| 5. For render changes, create representative media and inspect the encoded | ||
| dimensions, duration, frame rate, visual framing, and audible output. | ||
| 6. Update the public EDL example or usage documentation whenever users or agents | ||
| need to author a new field. | ||
|
|
||
| Cost and latency are secondary unless the user sets a budget or deadline. Improve | ||
| them only when output quality and reliability remain equal or improve. | ||
|
|
||
| ## Communication and commits | ||
|
|
||
| After code changes, summarize the affected files, the functions or contracts | ||
| added, and what each does in plain language. Keep this technical context compact | ||
| so someone can learn an unfamiliar codebase without reading every diff. | ||
|
|
||
| Write simple, readable commit messages. Prefer short lowercase wording without | ||
| punctuation. | ||
|
|
||
| ## Branch discipline | ||
|
|
||
| Several agents work on this repository at once. To keep one agent's progress | ||
| from being overwritten by another: | ||
|
|
||
| - One feature per branch, one agent per branch. Never edit a worktree that | ||
| belongs to another branch; take files from a commit or tag instead. | ||
| - Commit early. Uncommitted work in a worktree has no merge base and no | ||
| history, so a later sync silently discards it. | ||
| - Hard rules in `SKILL.md` are append-only. New rules get the next number. | ||
| Removing or renumbering a rule requires an explicit reason in the commit. | ||
| - Procedure prose belongs in `references/<feature>.md` at the repository root; | ||
| create that folder with the first reference file. Edits to `SKILL.md` | ||
| are limited to rules, helper-index bullets, directory-tree lines, the EDL | ||
| example, and one-line pointers to the reference files. | ||
| - `tests/test_skill_contract.py` checks that the rules and every referenced | ||
| path still exist. Run it before committing a `SKILL.md` change. |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P2: The normal
render.pypath never invokeslayout_qc.py, so collisions do not fail a render as this bullet promises. State the explicit QC command and workflow requirement, or wire layout validation into render preflight.Prompt for AI agents