Suggested new section: Task based Guide (to supplement faq)
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 30/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript, python
- Domain
- documentation
Research direction
Start by locating the current FAQ and user-guide navigation in the documentation source, then review how existing sections are organized. Add a task-based guide containing the proposed questions and relevant links, and verify that the links work and the new section is discoverable alongside the FAQ.
Written by the indexing model from the issue text.
Description
In some systems this might be the Faq and the current faq might be a series of guides or recipes.
Anyway the section might look like this:
Task based Guide:
Where do I begin
- https://docs.pyscript.net/2025.3.1/user-guide/first-steps/
How do I configure pyscript to load packages, and local files
- https://docs.pyscript.net/2025.3.1/user-guide/configuration/
How do I setup my local machine for pyscript development
- https://www.pyscript.com/
- https://docs.pyscript.net/2025.3.1/faq/#packaging-pointers
I've got an unexpected error
- https://docs.pyscript.net/2025.3.1/faq/#common-errors
Dom Event code is not being called
- https://docs.pyscript.net/2025.3.1/user-guide/ffi/#create_proxy
- https://docs.pyscript.net/2025.3.1/faq/#common-errors
Using a javascript module from my python code
- https://docs.pyscript.net/2025.3.1/user-guide/dom/#working-with-javascript
Direct dom manipulations from python
- https://docs.pyscript.net/2025.3.1/user-guide/dom/#pyscriptweb
- https://docs.pyscript.net/2025.3.1/api/#pyscriptweb
- https://docs.pyscript.net/2025.3.1/api/#pyscriptwhen
Sending Javascript args from python to Javascript (and vice versa)
- https://docs.pyscript.net/2025.3.1/user-guide/ffi/
Converting Python entities into Javascript args
- https://docs.pyscript.net/2025.3.1/user-guide/ffi/
Saving and loading from the in-browser filesystem
- https://docs.pyscript.net/2025.3.1/user-guide/filesystem/#the-in-browser-filesystem
- https://docs.pyscript.net/2025.3.1/api/#pyscriptstorage
Saving and loading from the user's local filesystem (single or multiple)
- https://docs.pyscript.net/2025.3.1/user-guide/filesystem/#the-devices-local-filesystem
- https://docs.pyscript.net/2025.3.1/api/#pyscriptfs
Recipe for saving/loading a file to users file system
- https://docs.pyscript.net/2025.3.1/faq/#upload
Fetching data from a remote URL
- https://docs.pyscript.net/2025.3.1/api/#pyscriptfetch
Getting user input from the Terminal
- https://docs.pyscript.net/2025.3.1/user-guide/terminal/
- https://docs.pyscript.net/2025.3.1/user-guide/editor/
Getting user input from the Ltk UI toolkit
- https://pyscript.github.io/ltk/?tab=2&runtime=mpy
Adjusting Terminal parameters (size, clearing, colors, etc)
- https://docs.pyscript.net/2025.3.1/user-guide/terminal/#xterm-reference
Running code in an editor style interface
- https://docs.pyscript.net/2025.3.1/user-guide/editor/
Getting access to media devices like Camera and Sound
- https://docs.pyscript.net/2025.3.1/user-guide/media/
- https://docs.pyscript.net/2025.3.1/api/#pyscriptmedia
Making a PWA and installing offline
- https://pyscript.com/docs/pwa
How do I make Workers work for me
- https://docs.pyscript.net/2025.3.1/user-guide/workers/
- https://docs.pyscript.net/2025.3.1/api/#pyscriptcoredonkey
- https://docs.pyscript.net/2025.3.1/faq/#possible-deadlock
- https://docs.pyscript.net/2025.3.1/faq/#workers-via-javascript
How do I find events indicating when pyscript is loaded/done, etc
- https://docs.pyscript.net/2025.3.1/faq/#pyscript-events
- Dominant language
- Python
- Stars
- 17
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from pyscript/docs
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
Difficulty 4/5 3-5 days Newbie friendliness 32/100
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
bancolombia/sentinel#23 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
bug client
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100