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

New react docs (only content) #96

Merged
merged 7 commits into from Jan 27, 2021
Merged

New react docs (only content) #96

merged 7 commits into from Jan 27, 2021

Conversation

ryyppy
Copy link
Member

@ryyppy ryyppy commented Nov 2, 2020

I created this branch as a replacement for #60 to be able to iterate on the React content independently from the website infrastructure. Turned out writing content for React is a long process, and I still want to work on other parts of the website :-)

Within this long running PR, only touch following files:

  • pages/docs/react/latest
  • scripts/extract-tocs.js


## Rules of Hooks

Hooks are just simple functions, but you need to follow _two rules_ when using them. ReScript doesn't enforce those rules within the compiler, so if you really want to enforce correct hooks conventions, you can use an [eslint-plugin](https://www.npmjs.com/package/eslint-plugin-react-hooks) to check your compiled JS output.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm just doing this (eslint the compiled JS output) and wondering whether it's the right way!

@mweichert
Copy link

Excellent work thus far!

@ryyppy ryyppy added this to the 2021 / January Release milestone Jan 3, 2021
@bdunn313
Copy link
Contributor

bdunn313 commented Jan 5, 2021

@ryyppy is there an opportunity to assist with this task? I'd love to point my team at one place for all our rescript / react docs, so I'd love to roll up my sleeves and assist.

It's a little unclear to me what the outstanding tasks are, if you could briefly point me in the right direction so I'm not stepping on your toes, I'll get to work! :D

@ryyppy
Copy link
Member Author

ryyppy commented Jan 5, 2021

Hey @bdunn313!

The rescript-react docs are mostly blocked by some scheduled changes to the ReScript JSX and some rescript-react API changes, so there's not much left to help here.

The planned release will be end of January, so hopefully it will not be long until launch!

@mweichert
Copy link

Thanks for all the work on this @ryyppy.

ReScript JSX and some rescript-react API changes

Is there a link that references the changes you're referring to above?

@ryyppy
Copy link
Member Author

ryyppy commented Jan 5, 2021

Is there a link that references the changes you're referring to above?

Not yet, Ricky and I are currently writing things up so we can discuss it with the community to address any edge cases for an easy migration

@ryyppy
Copy link
Member Author

ryyppy commented Jan 27, 2021

I will merge this now to get the ball rolling

@ryyppy ryyppy marked this pull request as ready for review January 27, 2021 19:16
@ryyppy ryyppy merged commit 1e45181 into master Jan 27, 2021
@ryyppy ryyppy deleted the new-react-docs-only branch January 27, 2021 19:17
@bdunn313
Copy link
Contributor

This is a great birthday present (31st)! It begins! 🥳

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

Successfully merging this pull request may close these issues.

None yet

4 participants