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

Expand reactive operator docs with category-based "Manual" articles #127

Open
banchan86 opened this issue Feb 11, 2025 · 0 comments
Open
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@banchan86
Copy link
Contributor

banchan86 commented Feb 11, 2025

As I was exploring #117 I realized that the different reactive operator groupings are good starting points for additional "Manual" articles to enhance our reactive documentation. This would be similar to how the the current "Subjects" article is structured (a general overview/explanation, followed by coverage of the individual operators). Some issues to consider:

  • Do we want to cover all the groups, or only some? Some articles that I def think would be good to spin off:
    • Filtering, selecting or grouping observables
    • Using multiple observable sequences (triggering, combining)
  • Where to put them?
    • We can put them under the language guide, but as the table of content grows, it might be better to spin off a new "Reactive" or "Working With Sequences" section to prevent the article TOC from becoming too overwhelming.
    • Some of the current content (especially the "Extend Bonsai" section) can be spun off as a new "Developers" section

I will list down more thoughts as they come to me, and spin off separate issues for the articles as they become more concrete, but for now this will serve as a meta issue for discussion.

@banchan86 banchan86 added the documentation Improvements or additions to documentation label Feb 11, 2025
@banchan86 banchan86 self-assigned this Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant