reactive-python / reactive-python/reactpy
Improve JavaScript components docs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.1k
- Forks
- 332
- PR merge metrics
- No merged PRs in 30d
Description
Current Situation
The current docs are sparse on information, making it hard for new users to develop custom components. In particular, we jump to a relatively complicated example with super-simple-chart without ever showing a "Hello World" example. Also, this example does not demonstrate interactivity.
Proposed Actions
Extend the docs to add the following information
- Simple "Hello World"
- Adding interactivity (event handling)
- Sending arbitrary JS data to Python
- Sending arbitrary Python data to JS
- Using a ReactJS component in a custom component
Contributor guide
No contributing guide indexed for this repository
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
Start by locating the existing custom component documentation and its super-simple-chart example. Review how the docs currently explain components, then add coverage for a Hello World example, event handling, JavaScript/Python data exchange, and using a ReactJS component; done means each proposed topic is documented with usable examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, python, react
- Domain
- documentation, frontend
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100