ReactiveX / ReactiveX/rxjs

[Docs] add compare section in documentation

Open
#4,418 5 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
TypeScript
Stars
31.7k
Forks
3k
PR merge metrics
No merged PRs in 30d

Description

I think it would be valuable to have a dedicated section in the docs where we compare similar operators.
I often see devs struggle with this particular issue. e.g. "should I use flatmap or switchmap for this usecase".
Also that's a point we can't make very clear in the api docs because there we are focused on that single operator.
For now I don't have any precise idea about the structure and the content itself. I just wanted to raise that idea so that it doesn't get lost :D

Feedback appreciated

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

No files, tests, or entry points are named. The proposal needs a defined documentation structure and content for comparing similar operators, including examples such as flatmap and switchmap, before implementation can begin.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.