Repository navigation
docs: add a terminal hero and a Motion Canvas explainer - #162
PatrickSys wants to merge 2 commits into
Conversation
Record map, then an edit-preflight search, on the eval-controlled fixture, and keep the explainer and media out of the npm package.
The packaged README can only link to shipped files or an external URL.
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c312df81a3
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| @@ -0,0 +1,125 @@ | |||
| # Prompts | |||
There was a problem hiding this comment.
This commit adds media/PROMPTS.md without archiving any existing Markdown file. The root AGENTS.md explicitly prohibits adding new .md files without archiving one first, so this addition violates the repository's documentation-growth constraint. Consolidate these prompts into an existing document or archive an existing Markdown file before introducing this one.
AGENTS.md reference: AGENTS.md:L211-L211
Useful? React with 👍 / 👎.
 [Low impact] The changes reach README readers and people creating or rendering project media. Fix the standalone explainer build and satisfy the Markdown rule before merging. FindingsSummaryAdds a terminal recording, a privacy drawing, and a standalone Motion Canvas explainer.
Acknowledged: PatrickSys explicitly describes the hero's low-confidence, not-ready-to-edit result as intentional. No finding is raised for that result. PatrickSys also states “Do not merge” in the PR description. Diagram%%{init: {'theme': 'neutral'}}%%
flowchart LR
Checkout[Checkout] --> Root[Install root dependencies]
Root --> Build[Build CLI]
Build --> Tape[Run hero tape]
Tape --> Assets[GIF and WebM artifacts]
Checkout --> Media[Install explainer dependencies]
Media --> Types[Check TypeScript]
Types --> Bundle[Bundle explainer]
Reviews (1) · Last reviewed commit: "docs: link the hero WebM to the reposito..." · Reviewed by Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| "extends": "@motion-canvas/2d/tsconfig.project.json", | ||
| "compilerOptions": { | ||
| "skipLibCheck": true, | ||
| "types": ["node"] |
There was a problem hiding this comment.
tsconfig.json requires node types, but the explainer declares no @types/node dependency and its lockfile installs none. On a clean checkout with only the explainer's dependencies installed, npm run build fails with “Cannot find type definition file for 'node'” before bundling. Add @types/node to the explainer's development dependencies and update its lockfile.
| @@ -0,0 +1,125 @@ | |||
| # Prompts | |||
There was a problem hiding this comment.
Adding media/PROMPTS.md without archiving another Markdown file violates the repository requirement: “No new .md files without archiving one first.” Move these prompts into an existing document, or archive another Markdown file. This requirement must be satisfied before merging.
Context Used: AGENTS.md (source)
Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!
What / Why
Adds a short terminal recording, a privacy diagram, and a Motion Canvas explainer. The recording is real CLI output. In this take the edit preflight says the match is low confidence and not ready to edit.
Do not merge.
Release notes
docs: add a terminal hero and a Motion Canvas explainerDocumentation and media only. No runtime change.
Hero
docs/tapes/hero.taperendersdocs/assets/hero.gifanddocs/assets/hero.webm.map, then the screen is cleared, thensearch --query 'auth headers' --intent edit --limit 3, then a pause on the preflight.tests/fixtures/codebases/eval-controlled.reindex --no-embeddings.pnpm buildandvhs docs/tapes/hero.tape, or run the manual workflowRender hero tape.README
docs/assets/code-stays-local.svg. The headline is "code never leaves the machine". The drawing also repeats the README sentences: code and indexes stay on the machine with the default local provider, and cloud embeddings are optional and send chunks to that provider.Explainer
media/explaineris a Motion Canvas 3.17.2 project, about 37 seconds, plain rectangles and text, no stock assets. Preview withnpm start.npm run buildtypechecks and bundles the scene. Motion Canvas 3.17 does not ship a headless render command; the ffmpeg exporter is there for the editor.media/PROMPTS.mdhas paste-ready prompts for Claude, image models, and video models. The sentences are copied from the README and the benchmark. The prompts tell the model to leave the recorded GIF as the hero and not invent a terminal result.License check
Motion Canvas 3.17.2 is MIT: https://github.com/motion-canvas/motion-canvas/blob/master/LICENSE
Remotion was checked on 2026-10-30 against https://www.remotion.dev/license and the Terms and Conditions v5.0. A solo author qualifies for Remotion's free license: an individual, or an organization of up to 3 people, including commercial video creation. That license is proprietary, not an OSI open-source license. Remotion was not added. MIT lets anyone who clones the repo render the explainer without a headcount check.
Package
npm pack --dry-runbefore and after this branch:The tarball grew by 317 bytes because the README text grew. The file list is the same.
media/, the GIF, the WebM, the SVG, and the tape are not in the package.Agent: cursor-cloud/cbc-visuals