Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

docs/api-guide.md: "an actor occupies its whole worker" contradicts multi-actor workers

Open Beginner friendly
#2,152 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@ericcurtin is already working on this.

Since Oct 4, 2026.

  • #2183 by @ericcurtin — open

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
go
Domain
documentation

Research direction

Read docs/api-guide.md around line 141 and compare its wording with docs/api-guide.md lines 66-67 and docs/glossary.md lines 48-50. Check cmd/ateom-gvisor/main.go and cmd/ateapi/internal/scheduling/scheduling.go for the current worker and scheduling behavior. Done means the documentation no longer contradicts multi-actor workers and accurately describes how requests are treated.

Written by the indexing model from the issue text.

Description

area/api kind/docs

docs/api-guide.md line 141 (v0.3.0) says: "requests are not consulted today (an actor occupies its whole worker)."

Since v0.2.0 (#1836), a worker hosts several actors at once: --max-actors defaults to 1000 (cmd/ateom-gvisor/main.go:83), and the scheduler places actors by remaining CPU and memory (cmd/ateapi/internal/scheduling/scheduling.go:153). docs/api-guide.md lines 66-67 and docs/glossary.md lines 48-50 already say so. On a v0.3.0 kind install with a two-replica gVisor WorkerPool, kubectl ate get actors showed two running actors on one worker pod at once.

The parenthetical at line 141 reads as the current placement rule and contradicts the other two passages. Suggest removing it, or restating it as how requests are treated now.

Dominant language
Go
Stars
4.4k
Forks
515
Avg merge
2d 15h
Merged PRs (30d)
258

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from agent-substrate/substrate

All issues in agent-substrate/substrate

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.