Skip to content

docs: directory component is legacy#13186

Merged
mendonk merged 6 commits into
release-1.10.0from
docs-directory-component-is-legacy
May 19, 2026
Merged

docs: directory component is legacy#13186
mendonk merged 6 commits into
release-1.10.0from
docs-directory-component-is-legacy

Conversation

@mendonk
Copy link
Copy Markdown
Collaborator

@mendonk mendonk commented May 18, 2026

#11604

Summary by CodeRabbit

  • Documentation
    • Directory component marked as legacy; users should migrate to Read File.
    • Updated Read File documentation to clarify support for multiple files via archives or folder uploads.
    • Updated tutorials (agent and chat-with-files) to use Read File for file loading workflows.
    • Added redirect from Directory component documentation to legacy components section.
    • Updated sidebar navigation to reflect component changes.

Review Change Stack

@mendonk mendonk self-assigned this May 18, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 18, 2026

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 028a6fae-980f-4146-8b53-8519b99d28e3

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Walkthrough

This PR migrates the legacy Directory component to deprecated status. The Directory documentation moves to the legacy archive, Read File gains guidance on multi-file handling, agent and chat tutorials are refactored to use Read File, and the sidebar removes the Directory entry with a client redirect established.

Changes

Directory to Read File Migration

Layer / File(s) Summary
Legacy Directory component documentation
docs/docs/Components/legacy-core-components.mdx
Directory component is added to legacy documentation with replacement guidance pointing to Read File and a full parameter table describing recursive directory loading, file type filtering, concurrency, and thread behavior.
Read File component updates
docs/docs/Components/read-file.mdx
Read File guidance now recommends users to bundle multiple files using archives or upload folders directly, replacing the prior suggestion to use the Directory component.
Tutorial refactoring to Read File
docs/docs/Tutorials/agent.mdx, docs/docs/Tutorials/chat-with-files.mdx
Agent tutorial replaces Directory with Read File for loading CSV data, including tool setup and diagram updates. Chat-with-files tutorial adds clarification that archives can be passed to Read File for multi-file loading.
Navigation and redirect setup
docs/docusaurus.config.js, docs/sidebars.js
Directory removed from the sidebar under "Files and Knowledge" and client redirect added from /directory to /legacy-core-components.

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 9
✅ Passed checks (9 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main change: marking the directory component as legacy across documentation. It accurately reflects the core objective of the changeset.
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.
Test Coverage For New Implementations ✅ Passed Check not applicable to this PR. This is a documentation-only PR with no source code changes, new components, or new features - all conditions required by the test coverage check.
Test Quality And Coverage ✅ Passed Documentation-only PR with no code implementations. Check for test quality is not applicable as there are no new code implementations, async functions, or API endpoints.
Test File Naming And Structure ✅ Passed Test file structure check not applicable to documentation-only PR with no test files.
Excessive Mock Usage Warning ✅ Passed Check is not applicable. PR contains only documentation and configuration changes (7 files: 5 MDX docs, 2 JS config files). No test files are present, so excessive mock usage cannot be assessed.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-directory-component-is-legacy

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 and usage tips.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels May 18, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 18, 2026

✅ Test Coverage Advisor

No source changes detected without accompanying tests. Thanks for keeping coverage up! 🎉

Advisory check only — never blocks merge.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels May 18, 2026
@github-actions

This comment has been minimized.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/docs/Components/legacy-core-components.mdx`:
- Around line 20-41: The docs list the Directory component's "types" parameter
as MessageTextInput but the source actually uses MultiselectInput; update the
parameter table entry under the Directory component in
legacy-core-components.mdx to change the Type for the "types" row from
MessageTextInput to MultiselectInput and ensure any related description still
applies (reference the "Directory" summary and the "types" parameter name to
locate the row).

In `@docs/docs/Tutorials/agent.mdx`:
- Line 62: Update the image reference in the markdown so the file name matches
the tutorial content: replace "tutorial-agent-with-directory.png" with a clearer
name such as "tutorial-agent-with-read-file.png" (or "tutorial-agent-tools.png")
in the image tag `![An Agent component connected to Read File and Web Search
components as tools](/img/tutorial-agent-with-directory.png)` so the alt text
and filename are consistent; ensure the renamed file is added to the /img
directory and the markdown reference is updated accordingly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 2ea2e62c-1903-43cb-8537-96ed2297495b

📥 Commits

Reviewing files that changed from the base of the PR and between cc009c9 and 3c3fec0.

📒 Files selected for processing (7)
  • docs/docs/Components/directory.mdx
  • docs/docs/Components/legacy-core-components.mdx
  • docs/docs/Components/read-file.mdx
  • docs/docs/Tutorials/agent.mdx
  • docs/docs/Tutorials/chat-with-files.mdx
  • docs/docusaurus.config.js
  • docs/sidebars.js
💤 Files with no reviewable changes (2)
  • docs/sidebars.js
  • docs/docs/Components/directory.mdx

Comment thread docs/docs/Components/legacy-core-components.mdx Outdated
Comment thread docs/docs/Tutorials/agent.mdx
@github-actions

This comment has been minimized.

Comment thread docs/docs/Components/legacy-core-components.mdx Outdated
Copy link
Copy Markdown
Collaborator

@aimurphy aimurphy left a comment

Choose a reason for hiding this comment

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

approved but please see my comments

Comment thread docs/docs/Components/read-file.mdx Outdated
Comment thread docs/docs/Tutorials/agent.mdx
@github-actions github-actions Bot added the lgtm This PR has been approved by a maintainer label May 18, 2026
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels May 19, 2026
@github-actions

This comment has been minimized.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels May 19, 2026
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels May 19, 2026
@github-actions

This comment has been minimized.

@mendonk mendonk enabled auto-merge May 19, 2026 15:33
@mendonk mendonk added this pull request to the merge queue May 19, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 19, 2026

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

Merged via the queue into release-1.10.0 with commit aefd8ac May 19, 2026
25 checks passed
@mendonk mendonk deleted the docs-directory-component-is-legacy branch May 19, 2026 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants