OpenFn / OpenFn/docs

We don't really have any docs for the worker?

Open
#666 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
23
Forks
20
Avg merge
3d 1h
Merged PRs (30d)
6

Description

I've just run a quick search and had a quick scan of the contents.

The Worker - and the whole process around how work is send out to another environment to execute - seems to be mostly (entirely?) unexplained.

This is a bit of a problem because this stuff really affects users

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

No files, tests, or entry points are named. Start by locating the Worker documentation and the material describing how work is sent to another environment, then identify the user-facing gaps; done means users can understand the Worker and that execution process from the documentation.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.