docs: simplify documentation and focus around cbq - #105
Merged
noamteyssier merged 1 commit intoAug 26, 2026
Merged
Conversation
noamteyssier
commented
Aug 26, 2026
noamteyssier
commented
Contributor
- remove examples focused around vbq and focus on cbq
- reduce large multiline comments into simpler one-liners
- update main readme to focus on cbq
- update changelog
- remove examples focused around vbq and focus on cbq - reduce large multiline comments into simpler one-liners - update main readme to focus on cbq - update changelog
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request performs a comprehensive documentation overhaul across the crate, simplifying docstrings, removing verbose comments, and updating examples to recommend the CBQ format over the superseded VBQ format. A review comment points out a potential compilation issue in a doc test within src/policy.rs where rand::rng() is used instead of rand::thread_rng().
noamteyssier
deleted the
docs/simplify-documentation-and-focus-around-cbq
branch
August 26, 2026 20:53
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
1 participant
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.