reactjs / reactjs/react.dev

Add pointer to "React with Hooks" docs port until docs rewrite is ready

Open
#3,435 3 comments 18 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
11.8k
Forks
7.9k
Avg merge
1d 11h
Merged PRs (30d)
11

Description

Per #3308 , the React team is working on a complete rewrite of the React docs, which is great.

Until then, the tutorials and examples still show classes as the default.

Meanwhile, there's a fantastic port of the current React docs that updates all examples and tutorials to show hooks as the primary approach, at https://reactwithhooks.netlify.app/ .

I'd like to suggest that we add some kind of a header notice or link on the front page and the tutorials that says something like:

We're currently working on a rewrite of the React docs to improve explanations and teach React hooks as the default approach. In the meantime, you may want to look at https://reactwithhooks.netlify.app/ to see these same tutorials written using React hooks.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the documentation site's front page and tutorial entry points, then review how notices or external links are presented there. Done means the requested React with Hooks link and explanatory notice appear on the front page and tutorials without waiting for the docs rewrite.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.