reactjs / reactjs/react.dev

Add warning to the Portals example page or remove the example.

Open
#5,236 0 comments 0 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

As far as I can tell, the Portals example at https://github.com/reactjs/reactjs.org/blob/main/content/docs/portals.md is wrong and buggy.

See https://github.com/facebook/react/issues/25604 for an example of that.

I therefore believe the example should either had a warning added, be fixed, or be removed. At least there should be some sort of temporary solution until the new documentation site is finished.

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

Review content/docs/portals.md and the linked facebook/react#25604 report first; compare the example's behavior with the current documentation context. Determine whether the accepted outcome is a warning, a correction, or removal, then verify the page clearly communicates the result.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.