Missing atom docs
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 893
- Forks
- 114
- Avg merge
- 8d 14h
- Merged PRs (30d)
- 3
Description
Describe the bug
Okay so i believe atoms need a dedicated docs page, describing what are they and how they compare with state
Steps to Reproduce the Bug or Issue
- Go to the docs
- Look for atom docs
- See that theres only an example without any docs
Expected behavior
I expected more documentation about this API
Screenshots or Videos
No response
Platform
- OS: [e.g. macOS, Windows, Linux]
- Browser: [e.g. Chrome, Safari, Firefox]
- Version: [e.g. 91.1]
Additional context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the existing atom example in the docs and the surrounding state documentation. Add a dedicated atom page explaining what atoms are and how they compare with state, then verify that the docs clearly cover this API beyond the existing example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100