Skip to content

[docs] Rewrite Job Application Assistant docs for JobApplyWorkflow #212

Description

@serge-ivo

Problem

The Job Application Assistant docs describe the old runtime-task flow instead of the current LLM-driven apply workflow.

The README still references FAGS, job.apply_basic, manual run_instance_task / approve_instance_task, and direct /applications endpoints. Current platform code starts the apply flow through POST /v1/instances/:instanceId/apply, which launches JobApplyWorkflow and drives the runner through /browser/snapshot and /browser/act.

Evidence

  • Stale doc: platform/agents/job-application-assistant/README.md
  • Current route: platform/workers/api/src/routes/instances-apply.ts
  • Agent tool path calls startJobApply: platform/workers/api/src/lib/storage-tools.ts
  • Root README already describes the newer route: platform/README.md
  • Manifest still declares old task types: platform/agents/job-application-assistant/agent.json

Scope

  • Replace FAGS terminology with ProAgentStore/PAGS terminology.
  • Replace job.apply_basic / task approval docs with the current POST /v1/instances/:id/apply flow.
  • Document dryRun, resumePath, profile/resume behavior, human handoffs, takeover/resume routes, and expected runner requirements.
  • Decide whether agent.json taskTypes / approvalRequiredFor should be updated or explicitly marked legacy.
  • Remove or clearly mark the direct worker /applications API section if it is no longer the current product path.

Acceptance Criteria

  • The Job Application Assistant README matches the implemented workflow route.
  • No current docs tell users to run job.apply_basic as the normal path.
  • Safety docs explain the current dry-run and handoff behavior accurately.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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