Skip to content

[docs] Update Coder docs for runner-node picker, engines, and package paths #211

Description

@serge-ivo

Problem

Coder docs lag behind the current multi-machine and engine implementation.

The public multi-machine doc says UI work remains to choose connected nodes, but the Settings tab now exposes a Runs on picker backed by /v1/instances/:id/runner-node. The Coder README also points to an obsolete console file path.

Evidence

  • Stale public doc: platform/platform-docs/coder-multi-machine.md
  • Generated stale HTML: platform/store/docs/coder-multi-machine/index.html
  • Runner-node API: platform/workers/api/src/routes/instances.ts
  • Coding session honors requested/pinned runner node: platform/workers/api/src/routes/coding.ts
  • Engine presets/auth live in platform/workers/api/src/lib/coding-engines.ts
  • Actual UI package: platform/agents/coder/web/src/CodingTab.tsx
  • Stale README path: platform/agents/coder/README.md says store/console/console-coding.js

Scope

  • Update Coder multi-machine docs to describe the existing Runs on picker and /runner-node behavior.
  • Document behavior when a pinned node is offline or online but not attached to the instance.
  • Update Coder README architecture paths to @proagentstore/coder-web / agents/coder/web/src/*.
  • Update engine docs for current defaults: Claude, Codex, Gemini, Grok, and local/Ollama where relevant.
  • Regenerate public docs if platform-docs changes.

Acceptance Criteria

  • Public Coder docs match the current UI/API behavior.
  • No docs say runner-node picker UI is still future work.
  • Coder README file paths match the repo.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions