Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate docs to hooks #2400

Closed
wants to merge 6 commits into from
Closed

Conversation

nickmccurdy
Copy link
Contributor

@nickmccurdy nickmccurdy commented Oct 6, 2019

Fixes #1788

This is a work in progress. I've converted most of the core documentation to use hooks, but I still need to test and update some examples. I'd still really appreciate feedback on how easy it is to learn with these documentation changes, and if there are any errors or inconsistencies.

Also please note that I'm not necessarily planning on removing the class documentation, it's just the easiest way to implement review these changes for now. I'm curious for suggestions about how to continue documenting classes, especially if it should be a separate legacy of the docs or a section specifically on classes (like the opposite of the current hooks section of the class docs).

Tasks

  • Update internal files for home page
  • Update internal files for docs
    • Installation
    • Main concepts
    • Advanced guides
    • API reference
    • Hooks (new)
    • Testing
    • Contributions
    • FAQ
  • Update external repositories
    • Update React package documentation
      • Readme
      • Warning/error messages
    • Update create-react-app template
  • Fix code highlighting
  • Search terms
    • lifecycle
    • render()
    • class
    • this.
  • Review state-and-lifecycle
  • Dogfood (search class in src and remove)
  • Merge hooks section content into main docs and migrate to classes (legacy)
  • Update warning pages
  • Update external example links (such as from CodePen and Gist)
  • Integrate hooks tutorial

@nickmccurdy nickmccurdy changed the title Migrate to hooks Migrate docs to hooks Oct 6, 2019
@reactjs-bot
Copy link

Deploy preview for reactjs ready!

Built with commit a5ce1f4

https://deploy-preview-2400--reactjs.netlify.com

@reactjs-bot
Copy link

reactjs-bot commented Oct 6, 2019

Deploy preview for reactjs ready!

Built with commit 3828181

https://deploy-preview-2400--reactjs.netlify.com

@nickmccurdy
Copy link
Contributor Author

I’ve stopped working on this as it’s too much work for me alone to make the existing docs make sense for hooks, and the React team is planning on rewriting them from scratch anyway.

@nickmccurdy nickmccurdy closed this Feb 6, 2020
@karlhorky
Copy link
Contributor

karlhorky commented Feb 6, 2020

Thanks for the update @nickmccurdy, too bad to hear, but understandable.

the React team is planning on rewriting them from scratch anyway

Do you have a reference for this? Would like to follow along if possible.

For now, your work being available on https://deploy-preview-2400--reactjs.netlify.com can help out with those looking for React docs with hooks now!

@karlhorky
Copy link
Contributor

karlhorky commented May 13, 2020

@nickmccurdy Do you have any references for this React docs rewrite plan?

In the meantime, I've started to save your version to the Internet Archive, in case the Netlify deploy preview goes away for whatever reason:

Installation

Main Concepts

@alexkrolick
Copy link
Collaborator

@rachelnabors is in charge of this on the React team side of things

@nickmccurdy
Copy link
Contributor Author

FYI I plan on keeping my docs fork up at least until the official docs are updated. I don’t plan on keeping my docs up to date, but I’d be happy to accept contributions if others are interested in helping out.

@karlhorky
Copy link
Contributor

Ah nice @nickmccurdy, do you think you could deploy it somewhere, just in case the Netlify deploy preview disappears?

I tried archiving it on the Internet Archive but apparently the links are already broken :(

@karlhorky
Copy link
Contributor

And that's great Nick, thanks.

@rachelnabors, anywhere public that we can follow along with the conversion of the React Docs to use hooks?

@nickmccurdy
Copy link
Contributor Author

@karlhorky It’s already deployed to Netlify. That’s a permanent deployment on their site, not just a preview.

@karlhorky
Copy link
Contributor

Ah you mean that there's a different deploy somewhere than the PR deploy preview at https://deploy-preview-2400--reactjs.netlify.com ?

@karlhorky
Copy link
Contributor

Ah maybe you mean this one here? https://reacthooks.nickmccurdy.com/

Sorry, just saw it on your repo now.

@karlhorky
Copy link
Contributor

For anyone else looking, there is another version of the React docs with hooks here: https://reactwithhooks.netlify.app/

@nickmccurdy
Copy link
Contributor Author

I'm now redirecting my fork to the React Docs Beta.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update docs to use hooks
5 participants