Repository navigation
docs: streamline homepages and organize project guides - #146
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.
Summary
Make the repository and documentation homepages easier to navigate: introduce vector indexes before quantization components, shorten the quick-start path, and collect papers on a dedicated page. Show GIST1M throughput and serialized index size using existing measurements, with actual recall, parameters and measurement limits linked from the homepage. A plotting script keeps the figure and selected-result tables synchronized.
Document txtai and zvec integrations with versioned sources and explicit API/platform boundaries. Move developer/maintainer guides under
docs/, consolidate maintenance contacts into CONTRIBUTING, and move example runners undersample/with repository-root path resolution. Update references and the CI path-test fixture.No library algorithms, public APIs, persisted formats or production dependencies change. No new benchmark measurements are claimed; agent workflow pilot files are excluded.
Testing
Full dataset example runs and downstream txtai end-to-end tests were not rerun. Integration pages distinguish source inspection from runtime validation.