rxjs-docs
rxjs-docs copied to clipboard
ReactiveX
Create individual issues for each operator.
We need to take each individual operator and create issues for these things. Feel free to have at it. Example: You can create 60 issues for Real World Examples for each individual operator and I would love you forever.
- Real world examples
- Examples in other frameworks
- Visual example
- Architectural use case
- Descriptions
- Use cases
- Edit here interface to allow people to contribute easily.
- Check out this list https://github.com/ReactiveX/rxjs/blob/master/doc/operator-creation.md#submitting-a-pr-for-an-operator
- Another short list of things for each operator: https://github.com/ReactiveX/rxjs/pull/2208#issuecomment-274623556
@ladyleet - I will get started on creating these issues, I am going to have a title of the issue as
Add operator : <Type of Operator> - <Operator Name>
Example: Add operator : combination - concat
This way it will be easy to filter/group out by category of operators. I have pinged @btroncone to get some thoughts on minimum details required for adding operator PR.
My understanding was to create a github issue for each operator. Sorry, if I had misunderstood this issue's description.
@ashwin-sureshkumar Did you ping me in another issue? Apologies, I have been super busy and must have missed it.
The current RxJS docs (which I believe we are extracting from) have the explanations and technical details nailed. The primary missing piece is examples and use cases. It's one thing to understand how it works technically but I think it's equally importantly to bridge the gap on 'why and when' I should use this operator.
My thought would be a brief (if possible) one sentence TLDR, followed by a primary use-case, examples starting from basic to advanced, then the highly technical explanations and details to follow. I think this setup would cater to the needs of the majority of developers visiting the docs while still maintaining the depth for those who wish to dive even deeper.
As far as where each should live I'm not really sure, do we know anything definitive on that @ladyleet? With how many and how in depth we are wanting examples to be does it make sense to still maintain them within the code? Maybe they could live in a folder in this repo and we could do something similar to Angular Material docs with their plunker integration? Maintaining each in a JSBin might not be ideal moving forward.
Anxious to hear everyone's thoughts!
@btroncone i'm super open to all of this. i think we should just start putting it in the areas of the operators that you have with your recent PR.
@ashwin-sureshkumar feel free to get started on this and maybe you can provide some insight onto where you think we should add it?
I always default to the idea that we should just get started and go with it.
I do think however, we should have individual issues for each operator.
Example:
: real world example : use case : visual example
And then do this for all 60 operators.
@ladyleet @btroncone - Checkout issue #63 and let me know if those details are sufficient for an issue. If not I will go ahead create those 60 issues.