pyscript / pyscript/docs

beginning-pyscript/#from-a-web-server needs python3 -m http.server

Open Beginner friendly
#108 0 comments 0 reactions 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

https://docs.pyscript.net/2024.5.2/beginning-pyscript/#from-a-web-server

, but any static web host will do (for example github...

It doesn't include python3 -m http.server which was mentioned at the top of the page:

https://docs.pyscript.net/2024.5.2/beginning-pyscript/#an-application

If you're using your local file system
... 
python3 -m http.server

Which A) works fine and B) is my preference.

Technically the docs say run it and refresh later but for a Getting Started follow these easy steps I was expecting to be told when to run the server and browse the URL.

Explicit is better than implicit.

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

Open the beginning-pyscript documentation at the “From a web server” section and compare it with the “An application” section, which already mentions python3 -m http.server. Update the getting-started steps to state when to run the server and browse its URL, then verify the instructions are explicit and consistent.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.