Add agents.md onboarding guide for coding agents#765
Merged
Conversation
Co-authored-by: arrayka <1551741+arrayka@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add agents.md file for coding agent onboarding
Add agents.md onboarding guide for coding agents
Feb 11, 2026
arrayka
requested changes
Feb 11, 2026
… and link to source files Co-authored-by: arrayka <1551741+arrayka@users.noreply.github.com>
arrayka
approved these changes
Feb 11, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new repository-root agents.md onboarding guide intended to help coding agents quickly understand DiskANN’s workspace layout and common dev workflows, primarily by linking to existing “source of truth” files.
Changes:
- Introduces
agents.mdwith a repo overview, crate tiering summary, and links to key project docs/config. - Documents common test commands and points to nextest and the baseline caching system docs.
- Documents formatting/clippy/coverage/CI references and a short “DON’T” testing patterns list.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
harsha-simhadri
approved these changes
Feb 11, 2026
Contributor
harsha-simhadri
left a comment
harsha-simhadri
left a comment
There was a problem hiding this comment.
OK for a first cut, lets not close issue yet.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: arrayka <1551741+arrayka@users.noreply.github.com>
arrayka
approved these changes
Feb 11, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #765 +/- ##
=======================================
Coverage 88.98% 88.98%
=======================================
Files 428 428
Lines 78365 78420 +55
=======================================
+ Hits 69730 69785 +55
Misses 8635 8635
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
arkrishn94
approved these changes
Feb 11, 2026
Open
Merged
hildebrandmw
added a commit
that referenced
this pull request
Feb 13, 2026
## What's Changed ### API Breaking Changes * Remove the `experimental_avx512` feature. by @hildebrandmw in #732 * Use VirtualStorageProvider::new_overlay(test_data_root()) in tests by @Copilot in #726 * save and load max_record_size and leaf_page_size for bftrees by @backurs in #724 * [multi-vector] Verify `Standard` won't overflow in its constructor. by @hildebrandmw in #757 * VirtualStorageProvider: Make new() private, add new_physical by @Copilot in #764 * [minmax] Refactor full query by @arkrishn94 in #770 * Bump diskann-quantization to edition 2024. by @hildebrandmw in #772 ### Additions * [multi-vector] Enable cloning of `Mat` and friends. by @hildebrandmw in #759 * adding bftreepaths in mod.rs by @backurs in #775 * [quantization] Add `as_raw_ptr`. by @hildebrandmw in #774 ### Bug Fixes * Fix `diskann` compilation without default-features and add CI tests. by @hildebrandmw in #722 ### Docs and Comments * Updating the benchmark README to use diskann-benchmark by @bryantower in #709 * Fix doc comment: Windows line endings are \r\n not \n\r by @Copilot in #717 * Fix spelling errors in streaming API documentation by @Copilot in #715 * Add performance diagnostic to `diskann-benchmark` by @hildebrandmw in #744 * Add agents.md onboarding guide for coding agents by @Copilot in #765 * [doc] Fix lots of little typos in `diskann-wide` by @hildebrandmw in #771 ### Performance * [diskann-wide] Optimize `load_simd_first` for 8-bit and 16-bit element types. by @hildebrandmw in #747 ### Dependencies * Bump bytes from 1.11.0 to 1.11.1 by @dependabot[bot] in #723 * [diskann] Add note on the selection of `PruneKind` in `graph::config::Builder`. by @hildebrandmw in #734 * [diskann-providers] Remove the LRU dependency and make `vfs` and `serde_json` optional. by @hildebrandmw in #733 ### Infrastructure * Add initial QEMU tests for `diskann-wide`. by @hildebrandmw in #719 * [CI] Skip coverage for Dependabot. by @hildebrandmw in #725 * Add miri test coverage to CI workflow by @Copilot in #729 * [CI] Add minimal ARM checks by @hildebrandmw in #745 * Enable CodeQL security analysis by @Copilot in #754 ## New Contributors * @backurs made their first contribution in #724 * @arkrishn94 made their first contribution in #770 **Full Changelog**: 0.45.0...0.46.0
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.
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.