pyscript / pyscript/docs

documentation 10.2 duplication (workers)

Open
#151 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
17
Forks
20
PR merge metrics
No merged PRs in 30d

Description

Under Web Workers in the User guide section there is some doc about Workers and a quiet link to the Built-in APIs section.
This Web Workers section is where this docs has 'traditionally' been found.

Now in Built-in APIs we see a lot more info, some duplicated from Web Workers, including new info e.g. about the Donkey.

My request is to move all the info with examples to one place. Manually comparing the different code in the two places to try to work out how it works, and is the code fragment new or different in some way, is difficult.

Contributor guide

Open the contributing guide

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

Start by comparing the Web Workers section in the User guide with the Built-in APIs section, including the Workers and Donkey examples. Consolidate the information and examples in one location, with no duplicated or conflicting guidance remaining.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.