Skip to content

docs: streamline homepages and organize project guides - #146

Merged
gouyt13 merged 1 commit into
mainfrom
docs/refresh-homepage-and-guides
Oct 21, 2026
Merged

gouyt13 merged 1 commit into
mainfrom
docs/refresh-homepage-and-guides

Conversation

@gouyt13

@gouyt13 gouyt13 commented Oct 21, 2026

Copy link
Copy Markdown
Member

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 under sample/ 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

  • Strict MkDocs build passed; Material emits its existing informational MkDocs 2.0 advisory.
  • Checked 122 local file links and README navigation; executed the README Python example in the existing environment.
  • Verified chart values against committed CSVs, byte-identical repeated regeneration, and visual layout.
  • Python lint/format checks, focused Ruff checks, and 12 CI routing tests passed.
  • ShellCheck and shell syntax checks passed; verified relocated runners resolve the repository root and preserve workflow commands.
  • Full diff whitespace check passed.

Full dataset example runs and downstream txtai end-to-end tests were not rerun. Integration pages distinguish source inspection from runtime validation.

@gouyt13
gouyt13 merged commit 0c69f5f into main Oct 21, 2026
47 checks passed
@gouyt13
gouyt13 deleted the docs/refresh-homepage-and-guides branch October 21, 2026 12:10
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