Skip to content

docs: update logo and clarify RaBitQ index names - #154

Merged
gouyt13 merged 1 commit into
mainfrom
docs/update-logo-and-index-names
Oct 22, 2026
Merged

gouyt13 merged 1 commit into
mainfrom
docs/update-logo-and-index-names

Conversation

@gouyt13

@gouyt13 gouyt13 commented Oct 22, 2026

Copy link
Copy Markdown
Member

Summary

Replace the logo in the README and documentation homepage with the supplied artwork, and use it in the documentation header.

Call the library's indexes IVF-RaBitQ and HNSW-RaBitQ throughout the documentation, navigation, benchmark labels and figures so readers can distinguish them from the generic algorithms. Keep API names, benchmark method IDs, baseline names and measurement data unchanged. Preserve existing section links with explicit HTML anchors.

Testing

  • Strict MkDocs build passed.
  • Python formatting and lint checks passed, including the benchmark label definitions.
  • Benchmark protocol tests: 12 passed.
  • Regenerated the homepage figure from the committed CSVs without rerunning measurements.
  • Checked local Markdown links, SVG XML, logo copies, and all five preserved anchors in the built site.
  • Checked anchor rendering with and without the Markdown attr_list extension.
  • git diff --check passed.

@gouyt13
gouyt13 merged commit 93f14e5 into main Oct 22, 2026
51 checks passed
@gouyt13
gouyt13 deleted the docs/update-logo-and-index-names branch October 22, 2026 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant