reactjs / react.dev

The React documentation website
https://react.dev/
Creative Commons Attribution 4.0 International
10.9k stars 7.45k forks source link

New guides wanted #83

Open bvaughn opened 6 years ago

bvaughn commented 6 years ago

Note this issue has some overlap with FAQ section issue #29.

We revamped the docs, but there are a few guides that are missing and that I think are essential.

Available

In progress

If somebody wants to work on this please comment here and let's figure out a plan. Help wanted!

Carry over from facebook/react/issues/8060

markerikson commented 6 years ago

The ReactPerf item may sorta be OBE ("overtaken by events"), since it's not included in v16.

bvaughn commented 6 years ago

Not sure what that acronym means but I assume you're suggesting we should remove it? 😄 I don't object.

JasonEtco commented 6 years ago

Not sure if you're already planning it, but I would add Didn't bind class methods to common troubleshooting issues 👍

markerikson commented 6 years ago

@bvaughn : yeah, that's what I was suggesting :)

@JasonEtco : the "troubleshooting" suggestion overlaps heavily with the proposal for an FAQ page.

AlmeroSteyn commented 6 years ago

@bvaughn Accessibility has been added and can be checked off :-)

mrscobbler commented 6 years ago

I'll take the glossary that I created in the old repo and migrate it to the new docs repo

alexkrolick commented 6 years ago

As @markerikson mentioned there is some overlap with the FAQ discussion (#29). PR #43 covers AJAX and some of the VDOM concepts although a full-fledged glossary would probably replace that section.

bvaughn commented 6 years ago

Thanks @AlmeroSteyn. I've removed that entry.

Yeah, there's some overlap. I spent a few hours merging/moving issues and PRs yesterday but some of the larger/vaguer ones like this are a bit hard to do without a bit of overlap. I'll add a note in the description about the relationship.

ishankbahl commented 6 years ago

Hey @bvaughn , I would like to work on "AJAX (just show how to use fetch() in lifecycles, mention cancellation issues)". Though now we don't have to talk about cancellation issues as fetch now supports abort https://developers.google.com/web/updates/2017/09/abortable-fetch Can I take this one?

bvaughn commented 6 years ago

It's all yours, @ishankbahl

alexkrolick commented 6 years ago

@ishankbahl @bvaughn AJAX is already in the FAQ PR #43, as I pointed out.

If that is too big of a PR to review I can break it up, but let's not duplicate effort.

bvaughn commented 6 years ago

Sorry for missing that note, @alexkrolick. Thanks for pointing it out. Yeah, maybe hold off on doing anything with the AJAX section until after #43 has been reviewed @ishankbahl.

mrscobbler commented 6 years ago

I just created a pull request for the glossary content: https://github.com/reactjs/reactjs.org/pull/153

damaera commented 6 years ago

while in vue docs there's something like this. image

I think routing should have their own menu, because almost all SPA have router. state management too.

mateoholman commented 6 years ago

I'll take a stab at creating a guide for publishing a component if no one is currently working on it?

bvaughn commented 6 years ago

Ok @mateoholman

ishankbahl commented 6 years ago

@bvaughn Can I take snapshot testing?

bvaughn commented 6 years ago

Sure @ishankbahl

ishankbahl commented 6 years ago

@bvaughn What outline do you suggest for this guide?

bvaughn commented 6 years ago

No clue 😄 Haven't thought about it any. Just migrated this issue from the old GitHub repo.

mateoholman commented 6 years ago

Created a new PR for the "Publishing a Component" guide - #211.

mateoholman commented 6 years ago

I'll try to tackle the community section per the recommendations in facebook/react#7117 next if no one is currently working on it?

bvaughn commented 6 years ago

It's yours, @mateoholman

mateoholman commented 6 years ago

After doing some prep/research, I see two approaches to the community section. Adding a new Resources section to the docs page similar to the React Native Docs or updating the React Wiki. Both have been suggested in previous issues - any preference @bvaughn ?

bvaughn commented 6 years ago

👋 Hi @mateoholman. Sorry for the slow response time but I've been traveling.

I'm personally more a fan of the community page/section because it's more open for community contributions.

mateoholman commented 6 years ago

:wave: Hi @bvaughn . No worries, I had been scrubbing some of the outdated / broken links from the previous section. I should have a PR ready for review in a few days. :beers:

mateoholman commented 6 years ago

@bvaughn Created a PR for the updated community section PR #252 . Mind if I take the "Animation with React Motion" guide next?

bvaughn commented 6 years ago

Sure @mateoholman. It's yours.

chiangs commented 4 years ago

@bvaughn I'd like to take the Troubleshooting Guide:

Besides the following you listed (like wrong element casing, not loaded DOM container, missing React in scope) any other items you suggest being covered?

bvaughn commented 4 years ago

Okay @chiangs, please feel free to work on that! :)

alDuncanson commented 3 years ago

It looks like portals have been taken care of right?

https://reactjs.org/docs/portals.html

spiritanand commented 1 year ago

Is this issue open? Can you assign it to me if it is?

KenFoss commented 7 months ago

@bvaughn Is anyone taking animation with react motion? I would like to give it a go.