Suggestion for Intro to React tutorial, where JSX is mentioned
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
Beginner to React.js but not to front end dev... or writing support documentation.
So, while just getting started on the Intro to React tutorial, I came across this comment, under the What is React? heading:
Most React developers use a special syntax called “JSX” which makes these structures easier to write. The
<div />syntax is transformed at build time to React.createElement('div').
I think that this ^ section be improved a bit in terms of clarity, especially for beginners—I looked at it and initially thought, "That <div /> syntax isn't familiar to me and doesn't even show up in the provided example!" Here's one approach that could be more readily understandable:
Most React developers use a special syntax called "JSX" which makes these structures easier to write. JSX allows for the use of standard HTML syntax (example:
<div>content</div>) which is then transformed at build time to React.createElement('div').
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
Start in the Intro to React tutorial under the What is React? heading and review the paragraph explaining JSX and the
example. Update the explanation so the JSX HTML example is clear to beginners, then verify that the wording matches the tutorial’s surrounding content.Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100