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

オープン
#180 コメント 6 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

pyscript/docs のほかの issue

pyscript/docs の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。