Skip to content

Overview documentation #315

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

Merged
merged 2 commits into from
Jul 4, 2025
Merged

Overview documentation #315

merged 2 commits into from
Jul 4, 2025

Conversation

nightkr
Copy link
Member

@nightkr nightkr commented Jun 27, 2025

Description

Fixes #300. (Or at least attempts to...)

It came out (much) less tutorialized than I had hoped for, but the goal is to give a rough summary of the problem domain and how list-op can be used to address it.

Definition of Done Checklist

  • Not all of these items are applicable to all PRs, the author should update this template to only leave the boxes in that are relevant
  • Please make sure all these things are done and tick the boxes

Author

Reviewer

  • Code contains useful comments
  • Code contains useful logging statements
  • (Integration-)Test cases added
  • Documentation added or updated. Follows the style guide.
  • Changelog updated
  • Cargo.toml only contains references to git tags (not specific commits or branches)

Acceptance

  • Feature Tracker has been updated
  • Proper release label has been added
  • Links to generated (nightly) docs added
  • Release note snippet added
  • Add type/deprecation label & add to the deprecation schedule
  • Add type/experimental label & add to the experimental features tracker

@nightkr nightkr requested a review from a team June 27, 2025 10:59
@NickLarsenNZ NickLarsenNZ moved this to Development: Waiting for Review in Stackable Engineering Jul 4, 2025
Maleware
Maleware previously approved these changes Jul 4, 2025
Copy link
Member

@Maleware Maleware left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor typos, other LGTM! Thanks :)

Copy link
Member

@Maleware Maleware left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thank you!

@nightkr nightkr enabled auto-merge July 4, 2025 10:47
@nightkr nightkr added this pull request to the merge queue Jul 4, 2025
Merged via the queue into main with commit 054a4d8 Jul 4, 2025
17 checks passed
@nightkr nightkr deleted the docs/overview branch July 4, 2025 11:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Development: Waiting for Review
Development

Successfully merging this pull request may close these issues.

Guidance-oriented listener documentation
2 participants