Skip to content

New React Docs #3308

Closed
Closed

Description

@nearestnabors

Updated September 29, 2022! We're close to completing the remaining pages, and there is now a link to the Beta site from the main site.


Updated October 22, 2021! We have released React Docs Beta. See more details in the announcement and leave feedback on this issue!


Updated June 10, 2021! Full details in this comment.


Over the next months, we're planning to rebuild our website with fresh content!

Since Hooks have become increasingly popular in the React community, we have heard from confused learners as well as industry trainers asking why the docs are still so class component-centric. Additionally, while more and more educational materials for React are being created every day, there are still things not being taught because we have failed to explain them well.

We want to make reactjs.org the best place to grok React. We want to be there with you from the moment you make your first component, to well into your career as your React knowledge deepens and advances.

The plan

The new docs will teach React Hooks-first, with a focus on “how to think in React” and deeply grok React over building an app in React. (There are many amazing frameworks with full stacks, tutorials, and learning paths we will point people to for a holistic kickstart.) We’ll have a section on React’s core concepts as well as an expanded and concise API reference.

Anyone can learn React

We want React to be accessible to learners of all backgrounds, so we’re going to expand our coverage to include:

  • explanations of some of the more complex programming concepts for folks just diving into computer science (welcome welcome!)
  • visual explanations and diagrams for people with visual learning styles
  • interactive code examples for people who learn by doing
  • early and integrated use of React DevTools and lint rules, to prepare the learner for real world debugging

Because so much of this is going to be new content with a different structure, most of the existing documentation will be archived rather than edited. (Don’t worry: you’ll still be able to access our “class”-ic docs for legacy and migration work and we’ll set up redirects where appropriate!)

To ensure consistent voice and narrative, Dan and Rachel will start by writing the core of the new content, but later on we will be accepting community contributions as usual when everything is in place.

We’re also surveying the community to learn how you use reactjs.org so we can see what’s working and what isn’t. If you have five minutes to spare, we’d love if you could take our 2020 community survey!

Translations

With the help of our wonderful translators, more people than ever before have access to React. We want to thank our translation community so much for their hard work and commitment to React's v1 docs. Their efforts have allowed people all over the world to learn, teach, and build with React, and we will need their help more than ever when v2 launches. We’ll reach out to start coordinating as soon as we have content ready to translate.

What to expect

We’re aiming to launch the new docs in early 2021. We've got the initial structure in place and are working on a new site we're wrangling design resources for. We've sharing early stage outlines with individual teachers and learners to gather feedback, and as we have more and more content prepared, we will start publishing previews to gather even more feedback. This is an iterative process, and we want to get this right! In the meantime, if you’re looking for the React docs with Hooks, check out this community-maintained version of the docs where all examples use Hooks.

Help us help you! Take the survey!

Want to help? We’re running a survey to help better understand and measure the React community, your needs, and where we can do better. If you have a moment, you’ll be helping us a lot! Please take our survey—and share it with your team, classmates, other people who use and learn React.

Thanks so much!—the React Core team

Activity

  1. pinned this issue on Oct 5, 2020
  2. smikitky commented on Oct 6, 2020

    @smikitky
    Member

    What will the translation process be like? The current translation bot merges everything from the original repo's master branch into each translation repo, but it sees only the master branch.

    The easiest approach would be to create a new docs-v2 directory on the master branch, alongside the current docs, so that translators can work on it as soon as new articles are made. (Of course, the new directory doesn't have to be live until it becomes ready in early 2021.)

  3. ericzorn93 commented on Oct 8, 2020

    @ericzorn93

    Always great news to here from the React Core Team. Excited to see the new website.

  4. jhayworthg commented on Oct 8, 2020

    @jhayworthg

    I think the visual diagrams of how React works will be incredibly helpful. It will encourage the benefits of how React. I am the type of person that likes to know how and why just as much as what when learning something. There is a bit of a mirage when learning React and why it is a great solution to frontend development. Getting a visual example of when a component updates and its relative child components update will go a long way to people understanding the concept.

  5. jjoselv commented on Oct 8, 2020

    @jjoselv

    Great! A good moment and place to put all experience gathered from explain complex concepts from Just JavaScript @gaearon AIR?
    Btw, count me in for Spanish translations of you want. 💪

  6. sondh0127 commented on Oct 8, 2020

    @sondh0127

    As a suggestion for an awesome react hook tutorial form 'EpicReact.Dev' https://github.com/kentcdodds/react-hooks

  7. maifeeulasad commented on Oct 8, 2020

    @maifeeulasad

    Just asking

    In future, is there any chance that Class Components becoming deprecated ?

    They are really cool to play around.

  8. AhmadMayo commented on Oct 8, 2020

    @AhmadMayo

    Adding my two cents, please add a "Why use react" section. I still reference the first talk I've seen that explained why was react invented in the first place. People learn and teach the "how" not the "why", and I think this has two major results:

    1. The "x is faster than react" content. This happens because they don't know that speed is no the most important concern for react. Modularity, easy to reason about code, predictability, maintainability, and resilience are.
    2. A lot of the developers that I've dealt with personally write code that is not aligned with these reasons. They focus on re-usability, because components and hooks, writing lots of and lots of very small components and I don't even know why.

    I'm sorry if this seems like a rant, and its not your fault, but people tend to forget, and as time passes by, it seems that more and more forget why we chose react in the first place.

  9. fuzunspm commented on Oct 8, 2020

    @fuzunspm

    Just asking

    In future, is there any chance that Class Components becoming deprecated ?

    They are really cool to play around.

    I like to use Class Components and I hope it will never be deprecated

  10. 459 remaining items

  11. theoludwig commented on Mar 16, 2023

    @theoludwig

    Time to close this issue?
    https://react.dev

    Congrats to the whole team, and thank you for this amazing well written documentation. 🎉

  12. danecando commented on Mar 16, 2023

    @danecando
    Contributor

    YAY 🎉 I've been subscribed to this issue for so long. So happy to see this launch finally. Thanks to everyone who contributed!

  13. joepetrillo commented on Mar 16, 2023

    @joepetrillo

    These new docs are incredible, well done 🍻

  14. khanfaysal commented on Mar 18, 2023

    @khanfaysal

    React new docs are awesome for beginners and I think it is to be best doc in any framework. Thanks for update.

  15. mir-hussain commented on Mar 18, 2023

    @mir-hussain

    The recent update of the React documentation has been positively received for its user-friendly approach, particularly for beginners in the field. This revision appears to have been strategically designed to simplify the learning process and improve comprehension of the React core concepts.

    However, there seems to be an issue with the installation section in the documentation. This may pose a challenge for beginners attempting to learn React, as they may not be familiar with the inner workings of Next.js or Remix, which are currently highlighted. It would be beneficial to give more prominence to other viable options, such as Vite and Parcel, to provide users with a more comprehensive selection of installation methods.

  16. mizanmahi commented on Mar 18, 2023

    @mizanmahi

    The recent update of the React documentation has been positively received for its user-friendly approach, particularly for beginners in the field. This revision appears to have been strategically designed to simplify the learning process and improve comprehension of the React core concepts.

    However, there seems to be an issue with the installation section in the documentation. This may pose a challenge for beginners attempting to learn React, as they may not be familiar with the inner workings of Next.js or Remix, which are currently highlighted. It would be beneficial to give more prominence to other viable options, such as Vite and Parcel, to provide users with a more comprehensive selection of installation methods.

    The matter at hand deserves careful and thoughtful consideration.

  17. thekayshawn commented on Mar 18, 2023

    @thekayshawn

    The left sidebar on the new docs doesn't seem efficient, at least on desktop screens. At first, neither of the links fired a response, and then, about a minute later, they seemed to work but with extreme lag and jitter. Here's a possible cause and effect:

    • Lazy loading - The pages are being loaded lazily and there's no loading indicator. On slower devices and connections, clicking on the links seems to fire no response until a minute later. Adding a loading indicator would pretty much solve the problem.
    • State management, I don't know how the states are being managed between the menus, but they seem extremely inefficient on potato (and even average) devices. The expanding and collapsing behaviour seems to drop the FPS to about 20.

    Furthermore, a UX issue that I've found was that clicking on the expanded menus didn't seem to close them. This is a common trend amongst collapsible menus to toggle between expanded and collapsed states from the same anchor.

  18. deleted a comment from vageherder on Mar 18, 2023
  19. deleted a comment from vageherder on Mar 18, 2023
  20. bear-bibeault commented on Mar 18, 2023

    @bear-bibeault

    Feedback for Context section:

    "This is why context is often used in combination with state."

    If "often" is the case, I feel an example is called for. The "level" example using a simple number is great as a first example, but just hand-waving over "state is often used" doesn't make the article as helpful as it could be.

  21. Assad-Ashraf commented on Mar 20, 2023

    @Assad-Ashraf

    @gaearon don't you think #5391 is to be marked closed? Since the thing i gave idea about is being implemented?

  22. KISGP commented on Apr 20, 2023

    @KISGP

    文档错别字,从头开始写成了“葱头开始”,页面连接:https://react.bootcss.com/learn/start-a-new-react-project
    image

  23. gaearon commented on Apr 22, 2023

    @gaearon
    Member

    I'm going to close this issue since the whole repo is about the new docs now. If something's not addressed, please file a specific issue.

  24. unpinned this issue on Apr 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions