Improve README and documentation coverage; add feature map and docs navigation#102
Merged
nikivanstein merged 1 commit intomainfrom Mar 7, 2026
Conversation
Contributor
Author
|
@anantashahane , Could you maybe verify why the e2e tests are not passing? |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Fixed inconsistencies in the readme and docs. Added a feature map to give easy navigation for users.
Feature Coverage Mapsection toREADME.mdthat links main features to their implementation files and corresponding docs pages.README.mdanddocs/Quickstart.rstto importBBOB_SBOXfromiohblade.benchmarksand removed an unsupportedllm=argument from the exampleExperiment(...)call.docs/Installation.rstto requireuv0.7.19+, corrected the Apple Silicon dependency group name toapple-silicon, and fixed related wording.docs/index.rst, adding a short documentation guide on the landing page, expanding the modules toctree, and adding new docs pages:docs/methods.rst,docs/behaviour_metrics.rst, anddocs/assets.rst.