Skip to content

Improve README and documentation coverage; add feature map and docs navigation#102

Merged
nikivanstein merged 1 commit intomainfrom
feature/codex-verify-and-improve-blade-documentation
Mar 7, 2026
Merged

Improve README and documentation coverage; add feature map and docs navigation#102
nikivanstein merged 1 commit intomainfrom
feature/codex-verify-and-improve-blade-documentation

Conversation

@nikivanstein
Copy link
Contributor

@nikivanstein nikivanstein commented Mar 5, 2026

Fixed inconsistencies in the readme and docs. Added a feature map to give easy navigation for users.

  • Added a Feature Coverage Map section to README.md that links main features to their implementation files and corresponding docs pages.
  • Updated Quick Start examples in README.md and docs/Quickstart.rst to import BBOB_SBOX from iohblade.benchmarks and removed an unsupported llm= argument from the example Experiment(...) call.
  • Modernized installation docs in docs/Installation.rst to require uv 0.7.19+, corrected the Apple Silicon dependency group name to apple-silicon, and fixed related wording.
  • Improved docs navigation by fixing the PyPI badge target in 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, and docs/assets.rst.

@nikivanstein nikivanstein added documentation Improvements or additions to documentation and removed codex labels Mar 6, 2026
@nikivanstein
Copy link
Contributor Author

@anantashahane , Could you maybe verify why the e2e tests are not passing?
I get everytime the same error: in test_full_matrix_experiment_optimization (the seed function is not valid, meaning the example solution we provide to ReEVO is causing an error).

@codecov
Copy link

codecov bot commented Mar 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@nikivanstein nikivanstein merged commit 4f6e13b into main Mar 7, 2026
10 of 12 checks passed
@nikivanstein nikivanstein deleted the feature/codex-verify-and-improve-blade-documentation branch March 7, 2026 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant