Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs for v1 #37

Open
7 of 27 tasks
voliva opened this issue May 1, 2021 · 1 comment
Open
7 of 27 tasks

Update docs for v1 #37

voliva opened this issue May 1, 2021 · 1 comment

Comments

@voliva
Copy link
Collaborator

voliva commented May 1, 2021

With the API stabilising for v1, we need to update the docs to match the latest changes.

More importantly, we also need improve the overall structure to make it easy to understand for newcomers.

Some actions that I've gathered from some chats, and some brainstorm:

  • Add video of react-rxjs presentation
  • Update existing examples using the auto-source$ feature of <Subscribe />
    (where aplicable)
    • Update reference of <Subscribe /> to reflect new changes
  • Update reference of utils with the latest changes
    • createSignal/createKeyedSignal
    • split/collect/collectValues deprecated
    • partitionByKey
    • combineKeys
    • getGroupedObservable
    • contextBinder
  • Add examples to reference
  • Add minimal example in react-rxjs' README.md
    (I think it will make it a bit more visual on first sight)
  • Add recipes
  • Add FAQ
    • Why isn't there a hook that accepts an observable as a parameter?
      value = useObservable(stream$)
    • I'm getting a "Missing subscription" exception, what's wrong?
    • Why isn't my signal emitting the value I just sent?
      (subscribing late to the signal)

What else am I missing? thoughts? @josepot

@hoclun-rigsep
Copy link
Contributor

Would like to suggest a 'recipe': Redux brags that its state management makes 'undo/redo' easy. Perhaps we should demonstrate that with react-rxjs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants