Skip to content

Add agents.md onboarding guide for coding agents - #765

Merged
Alex Razumov (arrayka) merged 5 commits into
mainfrom
copilot/add-agents-md-file
Feb 11, 2026
Merged

Add agents.md onboarding guide for coding agents#765
Alex Razumov (arrayka) merged 5 commits into
mainfrom
copilot/add-agents-md-file

Conversation

CopilotAI commented Feb 11, 2026•
edited
Loading

Copy link
Copy Markdown
Contributor
  • Address review feedback on agents.md
  • Remove duplicated facts - provide links to source files instead
  • Remove sections: Build System, Configuration Files, Critical Patterns & Conventions, Common Workflows, Troubleshooting, Quick Reference, Errors Encountered
  • Simplify CI/CD Pipeline to just a link
  • Simplify code coverage to mention requirement and link to .codecov.yml
  • Remove "Regenerating Baselines" subsection
  • Remove "Default Members" and "Important Directories" subsections
  • Keep DON'T section, remove DO section
  • Add notes about rustfmt/clippy not being installed by default
  • Remove papers reference (updating wiki with new architecture)
  • File reduced from 788 lines to 157 lines

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@arrayka
Add comprehensive agents.md onboarding guide
f69b545
Co-authored-by: arrayka <1551741+arrayka@users.noreply.github.com>
CopilotAI changed the title [WIP] Add agents.md file for coding agent onboardingAdd agents.md onboarding guide for coding agentsFeb 11, 2026
arrayka
Alex Razumov (arrayka) requested changes Feb 11, 2026
View reviewed changes
Comment threadagents.md Outdated
Comment threadagents.md Outdated
Comment threadagents.md Outdated
Comment threadagents.md Outdated
Comment threadagents.md Outdated
Comment threadagents.md Outdated
Comment threadagents.md Outdated
Comment threadagents.md Outdated
Comment threadagents.md
Comment threadagents.md Outdated
@arrayka
Simplify agents.md based on review feedback - remove duplicated facts…
7d3ca0a
… and link to source files
Co-authored-by: arrayka <1551741+arrayka@users.noreply.github.com>
@arrayka
Alex Razumov (arrayka) marked this pull request as ready for review February 11, 2026 21:08
CopilotAI reviewed Feb 11, 2026
View reviewed changes

CopilotAI 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

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.md with 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.

Comment threadagents.md Outdated
Comment threadagents.md
Comment threadagents.md Outdated
harsha-simhadri
Harsha Simhadri (harsha-simhadri) reviewed Feb 11, 2026
View reviewed changes
Comment threadagents.md Outdated
harsha-simhadri
Harsha Simhadri (harsha-simhadri) approved these changes Feb 11, 2026
View reviewed changes

@harsha-simhadriHarsha Simhadri (harsha-simhadri) 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.

OK for a first cut, lets not close issue yet.

@arrayka
Apply suggestions from code review
bf32662
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@arrayka
Add rustfmt/clippy install notes and remove papers reference
1be7d71
Co-authored-by: arrayka <1551741+arrayka@users.noreply.github.com>
@codecov-commenter

Codecov Comments Bot (codecov-commenter) commented Feb 11, 2026•
edited
Loading

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.98%. Comparing base (87a0757) to head (1be7d71).
⚠️ Report is 43 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@ Coverage Diff @@## main #765 +/- ##
=======================================
Coverage 88.98% 88.98% =======================================
Files 428 428 Lines 78365 78420 +55 =======================================
+ Hits 69730 69785 +55 
Misses 8635 8635
FlagCoverage Δ
miri88.98% <ø> (+<0.01%)⬆️
unittests88.98% <ø> (+<0.01%)⬆️

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

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

arkrishn94
Aditya Krishnan (arkrishn94) approved these changes Feb 11, 2026
View reviewed changes
Comment threadagents.md
Comment threadagents.md
Comment threadagents.md
@arrayka
Alex Razumov (arrayka) merged commit ea4078e into mainFeb 11, 2026
20 checks passed
@arrayka
Alex Razumov (arrayka) deleted the copilot/add-agents-md-file branch February 11, 2026 23:26
@arraykaAlex Razumov (arrayka) mentioned this pull request Feb 11, 2026
Open
@hildebrandmwMark Hildebrand (hildebrandmw) mentioned this pull request Feb 13, 2026
Merged
Mark Hildebrand (hildebrandmw) added a commit that referenced this pull request Feb 13, 2026
@hildebrandmw
Bump version to 0.46.0 (#776)
7cd231a
## 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
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@arraykaAlex Razumov (arrayka)arrayka approved these changes
Copilot code reviewCopilot
Copilot review effort, defaults to Lite
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@harsha-simhadriHarsha Simhadri (harsha-simhadri)harsha-simhadri approved these changes
@arkrishn94Aditya Krishnan (arkrishn94)arkrishn94 approved these changes

Assignees

@arraykaAlex Razumov (arrayka)

Copilot code reviewCopilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@codecov-commenter@arrayka@harsha-simhadri@arkrishn94