Following instructions in docs/index.md or README causes error. #1

New Issue

2026-05-18T22:27:48Z

brent.edwards commented

2026-05-18 22:27:48 +00:00

Summary

Following the docs in docs/index.md or README.md needs an example my-actor.yaml

Metadata

Commit message: docs(index.html) Add my-actor.yaml
Branch: docs/my-actor.yaml

Details

From a new docker image, type the following:

mkdir -p ~/test/20260518
cd ~/test/20260518
uv venv
source .venv/bin/activate
cd /app
uv pip install "cleveractors @ git+https://git.cleverthis.com/cleveragents/cleveractors-core@master"
cd ~/test/20260518
cat << EOF > actor.py
from cleveractors.actor import compile_actor
from cleveractors.actor.schema import ActorConfigSchema
from cleveractors.actor.yaml_loader import load_yaml_text

raw = load_yaml_text(open("my-actor.yaml").read())
config = ActorConfigSchema.model_validate(raw)
compiled = compile_actor(config)
print(compiled.metadata.node_ids)
EOF
python actor.py

Here will be the results:

Traceback (most recent call last):
  File "/home/devuser/test/20260518/actor.py", line 5, in <module>
    raw = load_yaml_text(open("my-actor.yaml").read())

The solution is to give a simple actor.py among the instructions.

# Summary Following the docs in `docs/index.md` or `README.md` needs an example `my-actor.yaml` # Metadata * Commit message: docs(index.html) Add my-actor.yaml * Branch: docs/my-actor.yaml # Details From a new docker image, type the following: ``` mkdir -p ~/test/20260518 cd ~/test/20260518 uv venv source .venv/bin/activate cd /app uv pip install "cleveractors @ git+https://git.cleverthis.com/cleveragents/cleveractors-core@master" cd ~/test/20260518 cat << EOF > actor.py from cleveractors.actor import compile_actor from cleveractors.actor.schema import ActorConfigSchema from cleveractors.actor.yaml_loader import load_yaml_text raw = load_yaml_text(open("my-actor.yaml").read()) config = ActorConfigSchema.model_validate(raw) compiled = compile_actor(config) print(compiled.metadata.node_ids) EOF python actor.py ``` Here will be the results: ``` Traceback (most recent call last): File "/home/devuser/test/20260518/actor.py", line 5, in <module> raw = load_yaml_text(open("my-actor.yaml").read()) ``` The solution is to give a simple `actor.py` among the instructions.

brent.edwards added the

labels 2026-05-18 22:27:48 +00:00

brent.edwards self-assigned this 2026-05-18 22:27:48 +00:00

brent.edwards changed title from ~~Following instructions in `docs/index.md` causes error.~~ to Following instructions in `docs/index.md` or README causes error.

2026-05-19 00:28:10 +00:00

brent.edwards referenced this issue from a commit

2026-05-19 01:47:00 +00:00

docs(my-actor.yaml): ad an example actor

brent.edwards referenced a pull request that will close this issue

2026-05-19 01:48:42 +00:00

docs(my-actor.yaml): add an example actor #3

brent.edwards added

State

In Review

and removed

State