Suggested new section: Task based Guide (to supplement faq)

未关闭
#180 6 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
30/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
停滞
技术栈
javascript, python
领域
documentation

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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
主要语言
Python
星标
17
派生
20
PR 合并指标
30 天内没有已合并 PR

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

pyscript/docs 的其他 Issue

查看 pyscript/docs 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。