Skip to content

Document a model step's files and watched folders - #56

Open
yohamta0 wants to merge 1 commit into
mainfrom
engine-files-watch
Open

yohamta0 wants to merge 1 commit into
mainfrom
engine-files-watch

Conversation

@yohamta0

@yohamta0 yohamta0 commented Oct 26, 2026 •

Copy link
Copy Markdown
Member

Documents two engine changes: chat.completion reading files with its prompt (dagucloud/dagu#3343) and the DAG-level watch block that starts a run for each file arriving in a folder (dagucloud/dagu#3344). Merge after those PRs ship in a release.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added guidance for attaching files to AI chat completions, including supported file sources, document and image handling, limits, and how file content is handled across turns.
    • Documented watched-folder scheduling, including polling behavior, run triggers, file-related environment variables, and how existing, replaced, or unreadable files are handled.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 26, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Walkthrough

The documentation adds details for supplying files to LLM steps and for starting DAG runs when files arrive in watched folders.

Changes: LLM File Input

Layer / File(s) Summary
Document LLM file inputs
step-types/llm/index.md
Documents accepted file inputs, extraction and image handling, limits, failure cases, session behavior, and configuration placement.

Watched Folder Scheduling

Layer / File(s) Summary
Document watched-folder scheduling
writing-workflows/scheduling.md
Documents watch configuration, polling and file-stability rules, run metadata, file eligibility, and scheduler behavior.

Priority: Normal

Estimated code review effort: 2 (Simple) | ~10 minutes

Merge Risk: Minimal · up to c562b

These documentation additions have no demonstrated merge-blocking defect. Home-directory expansion for the file-input example remains unverified; publication should follow the corresponding engine release as planned.

Pre-merge checks: Passed 5
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title clearly and concisely describes both documented changes: model-step files and watched folders.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (2 skipped: 2 unsupported.)

Finishing Touches: 💡 1
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
🛠️ Fix failing CI checks: 💡
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔇 Additional comments: 1
step-types/llm/index.md-185-185: 1

185-185: Minor · ⚠️ Potential issue · Low value

⚠️ Unverified finding
We couldn't verify this from the code. It is shown for review, not as a verified issue.

The example uses a home-directory glob, but with.files may treat ~ literally rather than expand it to the user's home directory.

The pattern matches no files and the documented example fails before sending a model request.

This can occur when: A reader copies the example with an invoice in their ~/Downloads directory.


Review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 12a630a7-1eab-4719-8c23-0cf99f152fd5
Commits

Reviewing files that changed from the base of the PR and between 2420808 and c562b74.

Files selected for processing: 2
  • step-types/llm/index.md
  • writing-workflows/scheduling.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

@cloudflare-workers-and-pages

Copy link
Copy Markdown
Contributor

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
dagu-sh-docs c562b74 Oct 26 2026, 02:22 PM

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant