docs(engine): clarify ENGINE_V2 opt-in startup - #2694
Conversation
There was a problem hiding this comment.
Code Review
This pull request introduces documentation and configuration for the opt-in Engine v2, updating the .env.example file, main and localized READMEs, and internal architecture docs. The changes explain how to enable the new engine via the ENGINE_V2=true environment variable. Feedback highlights inconsistencies between the main README and its localized versions, specifically regarding missing usage examples for installed binaries and missing links to the architecture documentation.
| # Start interactive REPL with engine v2 | ||
| ENGINE_V2=true cargo run |
There was a problem hiding this comment.
The main README.md is missing the examples for running the installed binary (ironclaw) which were added to all localized READMEs. For consistency and to help users who have installed the tool via Homebrew or other installers, please include them here as well.
| # Start interactive REPL with engine v2 | |
| ENGINE_V2=true cargo run | |
| # Start installed binary | |
| ironclaw | |
| # Start installed binary with engine v2 | |
| ENGINE_V2=true ironclaw | |
| # Start interactive REPL with engine v2 | |
| ENGINE_V2=true cargo run |
|
|
||
| ## 使い方 | ||
|
|
||
| Engine v2 は現在オプトインです。従来のエージェントループではなく新しいエンジンを使いたい場合は、IronClaw を `ENGINE_V2=true` 付きで起動してください。 |
There was a problem hiding this comment.
This localized README is missing the link to the Engine v2 architecture documentation that was added to the main README.md. Adding it would help users find more detailed information about enabling the new engine.
| Engine v2 は現在オプトインです。従来のエージェントループではなく新しいエンジンを使いたい場合は、IronClaw を `ENGINE_V2=true` 付きで起動してください。 | |
| Engine v2 は現在オプトインです。従来のエージェントループではなく新しいエンジンを使いたい場合は、IronClaw を ENGINE_V2=true 付きで起動してください。詳細は [Engine v2 architecture](docs/internal/engine-v2-architecture.md#enabling-engine-v2) を参照してください。 |
|
|
||
| ## 사용법 | ||
|
|
||
| Engine v2는 현재 옵트인입니다. 기존 에이전트 루프 대신 새 엔진을 사용하려면 `ENGINE_V2=true`를 설정해서 IronClaw를 시작하세요. |
There was a problem hiding this comment.
This localized README is missing the link to the Engine v2 architecture documentation that was added to the main README.md. Adding it would help users find more detailed information about enabling the new engine.
| Engine v2는 현재 옵트인입니다. 기존 에이전트 루프 대신 새 엔진을 사용하려면 `ENGINE_V2=true`를 설정해서 IronClaw를 시작하세요. | |
| Engine v2는 현재 옵트인입니다. 기존 에이전트 루프 대신 새 엔진을 사용하려면 ENGINE_V2=true를 설정해서 IronClaw를 시작하세요. 자세한 내용은 [Engine v2 architecture](docs/internal/engine-v2-architecture.md#enabling-engine-v2)를 참조하세요. |
|
|
||
| ## Использование | ||
|
|
||
| Сейчас engine v2 включается отдельно. Если вы хотите запускать новый движок вместо устаревшего цикла агента, запускайте IronClaw с `ENGINE_V2=true`. |
There was a problem hiding this comment.
This localized README is missing the link to the Engine v2 architecture documentation that was added to the main README.md. Adding it would help users find more detailed information about enabling the new engine.
| Сейчас engine v2 включается отдельно. Если вы хотите запускать новый движок вместо устаревшего цикла агента, запускайте IronClaw с `ENGINE_V2=true`. | |
| Сейчас engine v2 включается отдельно. Если вы хотите запускать новый движок вместо устаревшего цикла агента, запускайте IronClaw с ENGINE_V2=true. Подробности см. в [Engine v2 architecture](docs/internal/engine-v2-architecture.md#enabling-engine-v2). |
|
|
||
| ## 使用方式 | ||
|
|
||
| Engine v2 当前需要显式开启。如果你想运行新的引擎而不是旧的代理循环,请在启动 IronClaw 时设置 `ENGINE_V2=true`。 |
There was a problem hiding this comment.
This localized README is missing the link to the Engine v2 architecture documentation that was added to the main README.md. Adding it would help users find more detailed information about enabling the new engine.
| Engine v2 当前需要显式开启。如果你想运行新的引擎而不是旧的代理循环,请在启动 IronClaw 时设置 `ENGINE_V2=true`。 | |
| Engine v2 当前需要显式开启。如果你想运行新的引擎而不是旧的代理循环,请在启动 IronClaw 时设置 ENGINE_V2=true。详见 [Engine v2 architecture](docs/internal/engine-v2-architecture.md#enabling-engine-v2)。 |
Summary
ENGINE_V2=true.env.exampleand the internal Engine v2 architecture docTesting