Mintplex-Labs/anythingllm-docs
1
0
Fork 0
mirror of https://github.com/Mintplex-Labs/anythingllm-docs.git synced 2026-07-19 13:54:49 -04:00
Code Issues 16 Packages Projects Releases Wiki Activity

[PR #239] [MERGED] Docs: Scheduled Jobs guide #232

New Issue
Closed
opened 2026-06-05 15:22:46 -04:00 by yindo · 0 comments
yindo commented 2026-06-05 15:22:46 -04:00
Owner
Copy Link
Copy Source

📋 Pull Request Information

Original PR: https://github.com/Mintplex-Labs/anythingllm-docs/pull/239
Author: @angelplusultra
Created: 4/16/2026
Status: ✅ Merged
Merged: 4/29/2026
Merged by: @timothycarambat

Base: main ← Head: 238-scheduled-jobs-documentation

📝 Commits (10+)

  • 773ba45 init
  • a569442 fix bit about searchable results
  • 9031037 add images to scheduled jobs docs
  • e7a729b add margin between images
  • faa6524 add action button images and table
  • 1f741f8 remove unneeded section
  • 4ecf69c add section about stopping in-flight runs
  • fa3c39a improve opening paragraph
  • 50c255e add images for stopping a run
  • 30fe150 remove unneeded section

📊 Changes

30 files changed (+865 additions, -0 deletions)

View changed files

📝 pages/_meta.json (+9 -0)
➕ pages/scheduled-jobs/_meta.json (+47 -0)
➕ pages/scheduled-jobs/configuration.mdx (+124 -0)
➕ pages/scheduled-jobs/getting-started.mdx (+175 -0)
➕ pages/scheduled-jobs/overview.mdx (+52 -0)
➕ pages/scheduled-jobs/scheduling.mdx (+195 -0)
➕ pages/scheduled-jobs/viewing-runs.mdx (+263 -0)
➕ public/images/guides/scheduled-jobs/cron-builder-daily.png (+0 -0)
➕ public/images/guides/scheduled-jobs/cron-builder-hourly.png (+0 -0)
➕ public/images/guides/scheduled-jobs/cron-builder-minute.png (+0 -0)
➕ public/images/guides/scheduled-jobs/cron-builder-monthly.png (+0 -0)
➕ public/images/guides/scheduled-jobs/cron-builder-weekly.png (+0 -0)
➕ public/images/guides/scheduled-jobs/new-scheduled-job.png (+0 -0)
➕ public/images/guides/scheduled-jobs/run-details-files-expanded.png (+0 -0)
➕ public/images/guides/scheduled-jobs/run-details-metrics-expanded.png (+0 -0)
➕ public/images/guides/scheduled-jobs/run-details-prompt.png (+0 -0)
➕ public/images/guides/scheduled-jobs/run-details-responses-expanded.png (+0 -0)
➕ public/images/guides/scheduled-jobs/run-details-sections-collapsed.png (+0 -0)
➕ public/images/guides/scheduled-jobs/run-details-thinking-expanded.png (+0 -0)
➕ public/images/guides/scheduled-jobs/run-details-tool-calls-expanded.png (+0 -0)

...and 10 more files

📄 Description

Pull Request Type

  • ✨ feat

Relevant Issues

resolves #238

What is in this change?

Adds a new top-level guide under Sidebar > Guides > Scheduled Jobs documenting the Scheduled Jobs feature. The guide is structured as five user-facing pages:

  • Overview — what Scheduled Jobs is, use cases, and key concepts
  • Creating Your First Job — step-by-step walkthrough of the New Job form (name, prompt, schedule, tools) and how to manage existing jobs from the list
  • Scheduling & The Cron Builder — each builder frequency mode (every minute, hourly, daily, weekly, monthly), custom cron reference, common patterns, and time-zone caveat
  • Viewing Runs & Results — run statuses, run history, the run detail page (Prompt, Thinking, Tool Calls, Files, Response, Metrics), and Continue in Thread
  • Configuration & Limits — SCHEDULED_JOB_MAX_CONCURRENT, SCHEDULED_JOB_TIMEOUT_MS, the single-user-only requirement, per-job concurrency, and push notifications on job completion

Sidebar registration for the guide is added in pages/_meta.json, placed under the Guides separator.

Additional Information

  • Annotated screenshots included for the settings-sidebar location, empty/populated jobs list, New Job modal, all five cron-builder modes, run history, and every section of the run detail page (Prompt, Thinking, Tool Calls, Files, Response, Metrics).
  • Row-action icons (delete, edit, Run Now, toggle) rendered inline in a markdown table that matches the docs' default table styling.
  • All screenshots are under the 1MB threshold used by yarn img, so no image compression is needed.

Validations

  • Ensured updated documentation pass spell check
  • Updated or added relevant links as needed
  • Reviewed the changes for clarity and accuracy
  • Successfully ran the code locally without encountering errors

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/Mintplex-Labs/anythingllm-docs/pull/239 **Author:** [@angelplusultra](https://github.com/angelplusultra) **Created:** 4/16/2026 **Status:** ✅ Merged **Merged:** 4/29/2026 **Merged by:** [@timothycarambat](https://github.com/timothycarambat) **Base:** `main` ← **Head:** `238-scheduled-jobs-documentation` --- ### 📝 Commits (10+) - [`773ba45`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/773ba45b7267e71da1e247be4d56fb30052b6fdb) init - [`a569442`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/a569442f3afac734dd92a15f0dd89f02bf734c91) fix bit about searchable results - [`9031037`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/9031037e24e423adfd0a7e8077546f5c4d3d730b) add images to scheduled jobs docs - [`e7a729b`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/e7a729b253db9dc4ac4057a40c616bf74ee1b622) add margin between images - [`faa6524`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/faa65245b32ba6406c32d72cd71dec570e771013) add action button images and table - [`1f741f8`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/1f741f899c30a298388c80ebbad6afe41c9bc34d) remove unneeded section - [`4ecf69c`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/4ecf69c6cdd0a6bca3079a7caa2cdbbd0ab64cfd) add section about stopping in-flight runs - [`fa3c39a`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/fa3c39a9522eb5642aa127cc70dd428319657db6) improve opening paragraph - [`50c255e`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/50c255e9f0e2e844da50ba92d5860c2dfed9e3de) add images for stopping a run - [`30fe150`](https://github.com/Mintplex-Labs/anythingllm-docs/commit/30fe1502bdaa19c29231829261c15b58f845cebe) remove unneeded section ### 📊 Changes **30 files changed** (+865 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `pages/_meta.json` (+9 -0) ➕ `pages/scheduled-jobs/_meta.json` (+47 -0) ➕ `pages/scheduled-jobs/configuration.mdx` (+124 -0) ➕ `pages/scheduled-jobs/getting-started.mdx` (+175 -0) ➕ `pages/scheduled-jobs/overview.mdx` (+52 -0) ➕ `pages/scheduled-jobs/scheduling.mdx` (+195 -0) ➕ `pages/scheduled-jobs/viewing-runs.mdx` (+263 -0) ➕ `public/images/guides/scheduled-jobs/cron-builder-daily.png` (+0 -0) ➕ `public/images/guides/scheduled-jobs/cron-builder-hourly.png` (+0 -0) ➕ `public/images/guides/scheduled-jobs/cron-builder-minute.png` (+0 -0) ➕ `public/images/guides/scheduled-jobs/cron-builder-monthly.png` (+0 -0) ➕ `public/images/guides/scheduled-jobs/cron-builder-weekly.png` (+0 -0) ➕ `public/images/guides/scheduled-jobs/new-scheduled-job.png` (+0 -0) ➕ `public/images/guides/scheduled-jobs/run-details-files-expanded.png` (+0 -0) ➕ `public/images/guides/scheduled-jobs/run-details-metrics-expanded.png` (+0 -0) ➕ `public/images/guides/scheduled-jobs/run-details-prompt.png` (+0 -0) ➕ `public/images/guides/scheduled-jobs/run-details-responses-expanded.png` (+0 -0) ➕ `public/images/guides/scheduled-jobs/run-details-sections-collapsed.png` (+0 -0) ➕ `public/images/guides/scheduled-jobs/run-details-thinking-expanded.png` (+0 -0) ➕ `public/images/guides/scheduled-jobs/run-details-tool-calls-expanded.png` (+0 -0) _...and 10 more files_ </details> ### 📄 Description ### Pull Request Type - [x] ✨ feat ### Relevant Issues resolves #238 ### What is in this change? Adds a new top-level guide under **Sidebar > Guides > Scheduled Jobs** documenting the Scheduled Jobs feature. The guide is structured as five user-facing pages: - **Overview** — what Scheduled Jobs is, use cases, and key concepts - **Creating Your First Job** — step-by-step walkthrough of the New Job form (name, prompt, schedule, tools) and how to manage existing jobs from the list - **Scheduling & The Cron Builder** — each builder frequency mode (every minute, hourly, daily, weekly, monthly), custom cron reference, common patterns, and time-zone caveat - **Viewing Runs & Results** — run statuses, run history, the run detail page (Prompt, Thinking, Tool Calls, Files, Response, Metrics), and Continue in Thread - **Configuration & Limits** — `SCHEDULED_JOB_MAX_CONCURRENT`, `SCHEDULED_JOB_TIMEOUT_MS`, the single-user-only requirement, per-job concurrency, and push notifications on job completion Sidebar registration for the guide is added in `pages/_meta.json`, placed under the **Guides** separator. ### Additional Information - Annotated screenshots included for the settings-sidebar location, empty/populated jobs list, New Job modal, all five cron-builder modes, run history, and every section of the run detail page (Prompt, Thinking, Tool Calls, Files, Response, Metrics). - Row-action icons (delete, edit, Run Now, toggle) rendered inline in a markdown table that matches the docs' default table styling. - All screenshots are under the 1MB threshold used by `yarn img`, so no image compression is needed. ### Validations - [x] Ensured updated documentation pass spell check - [x] Updated or added relevant links as needed - [x] Reviewed the changes for clarity and accuracy - [x] Successfully ran the code locally without encountering errors --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
yindo added the pull-request label 2026-06-05 15:22:46 -04:00
yindo closed this issue 2026-06-05 15:22:46 -04:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
documentation
enhancement
good first issue
pull-request
Mirrored from GitHub Pull Request
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: Mintplex-Labs/anythingllm-docs#232
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?