Skip to content

change documentation link to repository link#1156

Open
harsha-simhadri wants to merge 3 commits into
mainfrom
harshasi/fix-repo-link-name
Open

change documentation link to repository link#1156
harsha-simhadri wants to merge 3 commits into
mainfrom
harshasi/fix-repo-link-name

Conversation

@harsha-simhadri

Copy link
Copy Markdown
Contributor

changes equivalent to #1115, which may not merge until CLA is accepted

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates Rust crate metadata so crates.io can link documentation to docs.rs (by removing the incorrect documentation field pointing at GitHub) while still providing a proper source link via repository.

Changes:

  • Replaced documentation.workspace = true with repository.workspace = true across published workspace crates.
  • Updated [workspace.package] metadata to set repository = "https://github.com/microsoft/DiskANN" (instead of documentation).
  • Normalized diskann-benchmark-core’s workspace-inherited package fields to the .workspace = true style while making the same metadata correction.

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated no comments.

Show a summary per file
File Description
Cargo.toml Switch workspace package metadata from documentation to repository so crates.io can use docs.rs for docs links.
diskann/Cargo.toml Inherit repository from workspace instead of documentation.
diskann-wide/Cargo.toml Inherit repository from workspace instead of documentation.
diskann-vector/Cargo.toml Inherit repository from workspace instead of documentation.
diskann-utils/Cargo.toml Inherit repository from workspace instead of documentation.
diskann-tools/Cargo.toml Inherit repository from workspace instead of documentation.
diskann-quantization/Cargo.toml Inherit repository from workspace instead of documentation.
diskann-providers/Cargo.toml Inherit repository from workspace instead of documentation.
diskann-platform/Cargo.toml Inherit repository from workspace instead of documentation.
diskann-linalg/Cargo.toml Inherit repository from workspace instead of documentation.
diskann-label-filter/Cargo.toml Inherit repository from workspace instead of documentation.
diskann-disk/Cargo.toml Inherit repository from workspace instead of documentation.
diskann-benchmark/Cargo.toml Inherit repository from workspace instead of documentation.
diskann-benchmark-simd/Cargo.toml Inherit repository from workspace instead of documentation.
diskann-benchmark-runner/Cargo.toml Inherit repository from workspace instead of documentation.
diskann-benchmark-core/Cargo.toml Convert workspace-inherited fields to dotted form and inherit repository (not documentation).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@harsha-simhadri harsha-simhadri force-pushed the harshasi/fix-repo-link-name branch from 32eeb41 to 23bc9f9 Compare June 12, 2026 22:32
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.46%. Comparing base (de5ac3c) to head (71d38d8).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1156   +/-   ##
=======================================
  Coverage   89.46%   89.46%           
=======================================
  Files         487      487           
  Lines       92106    92106           
=======================================
+ Hits        82401    82406    +5     
+ Misses       9705     9700    -5     
Flag Coverage Δ
miri 89.46% <ø> (+<0.01%) ⬆️
unittests 89.12% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.
see 2 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@harsha-simhadri harsha-simhadri enabled auto-merge (squash) June 13, 2026 01:04
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.

3 participants