Improve JavaScript components docs
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript, python, react
- Domain
- documentation, frontend
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.
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
- Dominant language
- Python
- Stars
- 8.1k
- Forks
- 332
- PR merge metrics
- No merged PRs in 30d
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.
More from reactive-python/reactpy
-
Outdated GIF in Docs Openpriority-3-low type-docs
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
reactive-python/reactpy#1034 ·
-
priority-2-moderate type-revision
Difficulty 5/5 Over a week Newbie friendliness 25/100
reactive-python/reactpy#1319 ·
-
priority-1-high
Difficulty 5/5 Over a week Newbie friendliness 25/100
reactive-python/reactpy#1277 ·
-
priority-3-low
Difficulty 5/5 Over a week Newbie friendliness 35/100
reactive-python/reactpy#1273 · 1 reaction ·
-
priority-2-moderate
Difficulty 5/5 Over a week Newbie friendliness 30/100
reactive-python/reactpy#1272 · 2 reactions ·
All issues in reactive-python/reactpy
Similar issues
-
Add: hunch Open
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
AbdelStark/awesome-typesafe#104 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
DiamondLightSource/dodal#2211 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
openml/openml-python#1749 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
sipyourdrink-ltd/bernstein#6191 ·