WIP: Improve top-level documentation#45
Draft
jonathanjouty wants to merge 5 commits into
Draft
Conversation
Rewrite the README from a 14-line stub into a feature-oriented overview that covers what the package provides: multi-queue support, LISTEN/NOTIFY dispatch, SKIP LOCKED reservation, scheduled jobs, configurable retries via ccOnException, dead-consumer reclamation, graceful shutdown, and the optional Prometheus metrics sibling. Adds two ASCII diagrams (component topology and job lifecycle) and a state table keyed by the (run_at, reserved_by, finished_at) columns that implicitly encode a job's state. Add module-level Haddock headers to all five exposed modules — none had one before — covering the entry point, the ConsumerConfig contract, consumer-registry bookkeeping, the three-daemon runtime, and the supporting Utils. Expand the per-constructor docs on Action to spell out which columns each variant mutates, and clarify the semantic role of the Ok/Failed split on Result. No code changes.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
WIP
Currently unreviewed AI slop that I need to verify when I have time.
Feel free to feedback if you like.
Rendered README
Expand README and add module-level Haddock headers
Rewrite the README from a 14-line stub into a feature-oriented overview that covers what the package provides: multi-queue support, LISTEN/NOTIFY dispatch, SKIP LOCKED reservation, scheduled jobs, configurable retries via ccOnException, dead-consumer reclamation, graceful shutdown, and the optional Prometheus metrics sibling. Adds two ASCII diagrams (component topology and job lifecycle) and a state table keyed by the (run_at, reserved_by, finished_at) columns that implicitly encode a job's state.
Add module-level Haddock headers to all five exposed modules — none had one before — covering the entry point, the ConsumerConfig contract, consumer-registry bookkeeping, the three-daemon runtime, and the supporting Utils. Expand the per-constructor docs on Action to spell out which columns each variant mutates, and clarify the semantic role of the Ok/Failed split on Result.
No code changes.