pyscript / pyscript/docs

Rewording around `config` as a must have

Open
#126 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

We had the community call https://www.youtube.com/watch?reload=9&v=2D7Wjoj2lXc and it was clear the optional need for a config attribute or <py-config> or even <mpy-config> is not super clear in our docs.

We start the configuration section like this: https://docs.pyscript.net/2024.6.1/user-guide/configuration/

We need to tell PyScript how we want such Python environments to be configured

While true as a statement, this is a bit misleading in there to me: we don't need to tell anything to any interpreter ... unless we do.

This issue is to try brainstorming or improve that initial Configuration paragraph that sounds like a config is needed by all mean, and we already had users slightly confused about empty configs and the config meaning in general.

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 with the Configuration section at https://docs.pyscript.net/2024.6.1/user-guide/configuration/ and review its opening paragraph about configuring Python environments. Done means the paragraph clearly explains that config is optional and avoids suggesting that every interpreter needs one, including the case of an empty config.

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
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.