PyEditor - Improve the docs about setup and config
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 17
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Description
The current page makes it hard to pin-point the setup part of the documentation + we're missing details around the config so that people believe having a py-config element on the page would actually have any effect on the py-editor but these are two different worlds so we need to be explicit about it.
/cc @ntoll
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.
Research direction
Locate the setup and configuration documentation page referred to in the issue, then read its existing py-config and py-editor sections. Clarify the setup instructions and explain that py-config does not configure py-editor; done when the page explicitly distinguishes them and covers the missing configuration details.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100