Skip to content

docs: fix nested agent guide loading and trim root AGENTS.md#7992

Merged
Xuanwo merged 2 commits into
mainfrom
xuanwo/agents-md-nested-guide-loading
Jul 24, 2026
Merged

docs: fix nested agent guide loading and trim root AGENTS.md#7992
Xuanwo merged 2 commits into
mainfrom
xuanwo/agents-md-nested-guide-loading

Conversation

@Xuanwo

@Xuanwo Xuanwo commented Jul 24, 2026

Copy link
Copy Markdown
Collaborator

rust/AGENTS.md and docs/src/format/AGENTS.md were never reaching coding agents. Nested guides are discovered through a CLAUDE.md entry point in the directory — protos/, python/, and java/ each have one, but those two directories did not. The Rust guide is the largest and most safety-relevant of the set, carrying the spawn_cpu() non-blocking contract, the RowAddr/RowId type separation, and the lance-encoding hot-path rules, so agents editing rust/ had none of it in context.

The root AGENTS.md also carried a hand-maintained crate list that duplicates what ls rust/ and each crate's Cargo.toml description already state, and it had drifted: arrow-scalar, arrow-stats, lance-derive, lance-index-core, lance-namespace-datafusion, lance-select, and lance-tokenizer were all missing. A stale map is worse than no map, and every session that loads the file pays for it. The directory-guide pointer above the list is unchanged, so navigation is unaffected.

The format vote reminder will fire on this PR because it adds a path under docs/src/format/. That path is a symlink to the agent guide already in that directory; the format specification itself is untouched.

Xuanwo added 2 commits July 25, 2026 02:31
Nested agent guides are discovered through a CLAUDE.md entry point.
protos/, python/, and java/ already had one; rust/ and
docs/src/format/ did not, so their AGENTS.md never loaded.
The list restates what `ls rust/` and each crate's Cargo.toml
description already provide, and it had drifted out of sync with the
workspace.
@github-actions

Copy link
Copy Markdown
Contributor

Important

This PR touches the Lance format specification.

Substantive changes to the format specification — the .proto definitions
and the spec docs under docs/src/format/ — require a PMC vote before merge.
Minor edits such as typo fixes, wording, or formatting are excluded; use your
judgment.

If this is a meaningful format change:

  • Start a vote following the Lance community voting process.
    Format specification modifications need 3 binding +1 votes (excluding the
    proposer), held on GitHub Discussions, with a minimum voting period of 1 week.
  • Once the vote passes, link the completed vote in this PR. It should not be
    merged until the vote is linked.

@coderabbitai

coderabbitai Bot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: QUIET

Plan: Pro Plus

Run ID: 8ccaaa69-b5fb-418a-857b-13a1946eae68

📥 Commits

Reviewing files that changed from the base of the PR and between 9225744 and 5f72270.

📒 Files selected for processing (3)
  • AGENTS.md
  • docs/src/format/CLAUDE.md
  • rust/CLAUDE.md
💤 Files with no reviewable changes (1)
  • AGENTS.md

📝 Walkthrough

Walkthrough

The Architecture section was removed from AGENTS.md. The format and Rust CLAUDE.md files now symbolically link to AGENTS.md.

Changes

Guidance consolidation

Layer / File(s) Summary
Update root guidance
AGENTS.md
Removes the Rust workspace Architecture section.
Link subordinate guidance
docs/src/format/CLAUDE.md, rust/CLAUDE.md
Replaces independent guidance content with symbolic links to AGENTS.md.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Suggested labels: documentation, A-format

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: adding agent guide entry points and removing the outdated root AGENTS.md list.
Description check ✅ Passed The description is clearly related to the PR and explains the nested guide entry points and root AGENTS.md cleanup.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch xuanwo/agents-md-nested-guide-loading

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added A-format On-disk format: protos and format spec docs documentation Improvements or additions to documentation labels Jul 24, 2026
@Xuanwo
Xuanwo marked this pull request as ready for review July 24, 2026 18:32
@Xuanwo
Xuanwo requested a review from wjones127 July 24, 2026 18:34
@Xuanwo
Xuanwo merged commit e0fb830 into main Jul 24, 2026
34 checks passed
@Xuanwo
Xuanwo deleted the xuanwo/agents-md-nested-guide-loading branch July 24, 2026 18:41
@codecov

codecov Bot commented Jul 24, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-format On-disk format: protos and format spec docs documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants