facebookexperimental/Recoil

[docs] Finish performance.md

Open

#190 opened on May 28, 2020

View on GitHub
 (9 comments) (0 reactions) (1 assignee)JavaScript (19,428 stars) (1,151 forks)batch import
documentationhelp wanted

Description

Need to finish this docs page and then add it to docusaurus sidebar. It’s critical for newcomers. Took me several hours to understand this, which tbh I’m not 100% on still.

rough outline

  • use atomFamily for each updatable key of todo, making use of separate components and react.memo to push state down to leaf nodes
  • bonus: show what would be required if there was an initial list of todos (as if it were fetched from an api).
    • show how to use selectorFamily to select default value, may require keeping an initialState atom?
    • show how to write a selector to roll back together todos into a list in using todoIdsState.map(id => ...) and getting each part back out atomFamily

Contributor guide

Tech stack
javascriptreact
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic React knowledgeRecoil fundamentals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
The issue provides a rough outline for the performance.md page. First, review existing Recoil documentation and the current Docusaurus sidebar configuration to understand the structure. Then, follow the outline to write the documentation, including code examples for atomFamily and selectorFamily. Ensure the page is added to the sidebar by editing the sidebar configuration file. Check the issue comments for any additional guidance from maintainers.