docs: improve accuracy of symlink-contents description in README.md

[yacosta738]

This pull request provides a minimal update to the README.md to ensure technical accuracy regarding the symlink-contents synchronization type.

Changes:

• Modified the description of symlink-contents in the Target Types table from "each file" to "each item".
• This change correctly reflects that AgentSync synchronizes all entries (both files and directories) at the top level of the source directory, as implemented in src/linker.rs.

Verification:

• Verified against the implementation in src/linker.rs which uses WalkDir to iterate over all items at depth 1.
• All relevant tests (make rust-test) pass.
• The update adheres to the "minimal change" policy, preserving the existing structure and intent of the documentation.

---

PR created automatically by Jules for task 14053228165477362643 started by @yacosta738

[google-labs-jules]

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.

---

For security, I will only act on instructions from the user who triggered this task.

[coderabbitai]

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Updated the symlink-contents feature description in the README for improved clarity and accuracy.

Walkthrough

The README.md documentation was updated to clarify the description of the symlink-contents type. The wording was changed from "Create symlinks for each file in the source directory" to "Create symlinks for each item in the source directory" in two locations.

Changes

Cohort / File(s)	Summary
Documentation README.md	Updated symlink-contents type description to use "item" instead of "file" for clarity (2 occurrences).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A word here, a word there,
Makes docs more fair and square!
From "file" to "item" we hop along,
Precision in language makes it strong! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately and specifically describes the main change—improving the accuracy of the symlink-contents description in README.md—which directly corresponds to the changeset's documentation update.
Description check	✅ Passed	The description is clearly related to the changeset, providing detailed context about the documentation update from 'each file' to 'each item', explaining the rationale, and documenting verification steps.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs-readme-accuracy-update-14053228165477362643

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[github-actions]

✅ Contributor Report

User: @yacosta738
Status: Passed (12/13 metrics passed)

Metric	Description	Value	Threshold	Status
PR Merge Rate	PRs merged vs closed	89%	>= 30%	✅
Repo Quality	Repos with ≥100 stars	0	>= 0	✅
Positive Reactions	Positive reactions received	9	>= 1	✅
Negative Reactions	Negative reactions received	0	<= 5	✅
Account Age	GitHub account age	3035 days	>= 30 days	✅
Activity Consistency	Regular activity over time	108%	>= 0%	✅
Issue Engagement	Issues with community engagement	0	>= 0	✅
Code Reviews	Code reviews given to others	361	>= 0	✅
Merger Diversity	Unique maintainers who merged PRs	3	>= 0	✅
Repo History Merge Rate	Merge rate in this repo	0.8157894736842105	>= 0	✅
Repo History Min PRs	Previous PRs in this repo	84	>= 0	✅
Profile Completeness	Profile richness (bio, followers)	90	>= 0	✅
Suspicious Patterns	Spam-like activity detection	1	N/A	❌

---

_{Contributor Report evaluates based on public GitHub activity. Analysis period: 2025-02-17 to 2026-02-17}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Around line 354-357: Update the README paragraph describing the
`symlink-contents` type so its terminology matches the table entry: change the
phrase "filter which files to link" to "filter which items to link" (referencing
the `symlink-contents` type and its optional `pattern` field) so the docs
correctly reflect that the pattern applies to directory entries (items) rather
than only files.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Incomplete terminology update — "files" at line 357 still needs to be changed to "items".

The table entry on line 354 was correctly updated to "each item", but the immediately following paragraph on line 357 still reads "filter which files to link", which contradicts the updated wording and the stated intent (WalkDir iterates all entries — files and directories — at depth 1).

The AI summary states the change was applied in "two places", but only line 354 is annotated as changed (~); line 357 was left as-is.

📝 Proposed fix to align line 357 with the updated terminology

-The `symlink-contents` type optionally supports a `pattern` field (glob pattern like `*.md`) to
-filter which files to link.
+The `symlink-contents` type optionally supports a `pattern` field (glob pattern like `*.md`) to
+filter which items to link.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	| `symlink-contents` | Create symlinks for each item in the source directory |
	The `symlink-contents` type optionally supports a `pattern` field (glob pattern like `*.md`) to
	filter which files to link.
	| `symlink-contents` | Create symlinks for each item in the source directory |
	The `symlink-contents` type optionally supports a `pattern` field (glob pattern like `*.md`) to
	filter which items to link.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 354 - 357, Update the README paragraph describing the
`symlink-contents` type so its terminology matches the table entry: change the
phrase "filter which files to link" to "filter which items to link" (referencing
the `symlink-contents` type and its optional `pattern` field) so the docs
correctly reflect that the pattern applies to directory entries (items) rather
than only files.