docs: cleanup/rewrite#37
Merged
Merged
Conversation
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
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.
This pull request updates both the
README.mdandBENCHMARKS.mdfiles to provide clearer, more concise, and better-structured documentation for users and contributors. The changes focus on improving usability by clarifying installation steps, usage examples, API descriptions, implementation details, and benchmark instructions, while removing outdated or redundant information.Documentation and usability improvements:
README.mdto provide a concise project overview, clearer install instructions for both Python and Rust, and practical usage examples for each language. The new format uses tables for API and implementation details, and removes redundant or outdated sections.BENCHMARKS.mdfile to focus on how to run benchmarks, what is measured, and how to interpret results. Removed point-in-time timing tables and replaced them with instructions for saving and annotating results, as well as tables describing measured operations and comparison constraints.