mirror of
https://github.com/nearai/ironclaw.git
synced 2026-09-02 23:56:24 +08:00
7f5b02d7f0
* feat(docs): animated architecture overview video for contributors Adds a Remotion-based animated video (82s, 12 scenes at 30fps) that visualizes the IronClaw architecture for new contributors. Covers engine v2 primitives, CodeAct execution, thread state machine, skills pipeline, tool dispatch, channel routing, trait implementations, and LLM decorator chain. - docs/architecture-video/ — Remotion project with 12 animated scenes - scripts/render-architecture-video.sh — render script - .claude/skills/architecture-video/ — Claude Code skill to update the video when architecture changes Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix(docs): address PR review feedback and fix cargo-deny CI - Resolve relative output paths in render script before cd - Use npm ci when package-lock.json exists for reproducible builds - Fix file paths in TraitsScene, ChannelImplsScene, CodeActScene - Label Channel trait code as simplified in ChannelsRoutingScene - Fix TypeScript version (5.9.3 → 5.7.3) and update lockfile - Add dom/esnext to tsconfig lib for React 19 compatibility - Fix license to MIT OR Apache-2.0 to match repo - Fix TOTAL_DURATION to count only scenes with transitions - Fix cargo-deny: add publish = false, ignore RUSTSEC-2026-0097 Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix(docs): address remaining PR review feedback - Remove `publish = false` from Cargo.toml (unrelated build policy change, should be a separate PR if desired) - Add `--` before output path in render script to prevent argument injection Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix(docs): address second round of PR review feedback - Add npm command check to render script (was only checking node/npx) - Memoize highlight() tokenization in CodeBlock — Remotion re-renders every frame and code is static per instance, so useMemo avoids repeated work - Rewrite README to describe the IronClaw architecture video project instead of the default Remotion template Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
IronClaw Architecture Overview Video
A Remotion-based animated video that walks new contributors through IronClaw's internals — the five primitives, execution loop, CodeAct, thread state machine, skills pipeline, tool dispatcher, channels, extensibility traits, and the LLM provider decorator chain.
See the project-level render script and Claude skill for end-to-end use:
scripts/render-architecture-video.sh— one-command MP4 render.claude/skills/architecture-video/SKILL.md— how to update scenes when architecture changes
Commands
Install dependencies (first time only):
npm ci
Preview in browser (Remotion Studio with hot reload):
npm run dev
Render to MP4 from this directory:
npx remotion render IronClawArchitecture out.mp4
Or from the repository root:
./scripts/render-architecture-video.sh output.mp4
Type-check and lint:
npm run lint
Structure
src/IronClawArchitecture.tsx— scene sequencing, durations, transitionssrc/scenes/*.tsx— one file per scene (12 total)src/components/Code.tsx— shared syntax-highlighted code blocksrc/theme.ts— shared colors and fontssrc/Root.tsx— Remotion composition registration
License
This video project is part of IronClaw and dual-licensed MIT OR Apache-2.0. Remotion itself has a custom license; use is covered under the open-source free tier for this project.