Inconsistency in react docs
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
I wanted to open an issue some days ago about some inconsistencies I found in the documentation of react, today I saw again and saw most of them were fixed as the image below. In API REFERENCE import sections is now as:
in other sections it was in plain text. The only section which still has plain text is React Top-Level API, I am not sure if it should be modified at least from "If you use ES6 with npm, you can write import React from..." as the other sections has.
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 with the linked React Top-Level API page and compare its import guidance with the other API Reference sections shown in the issue. Confirm the documentation convention, then update the remaining plain-text guidance if appropriate; done means the import sections use consistent wording and formatting.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100