Skip to content

docs: Rework the Scheduling section for 4.0 - #719

Merged
developerjamiu merged 5 commits into
mainfrom
concepts-phase3-section6-scheduling
Jul 28, 2026
Merged

docs: Rework the Scheduling section for 4.0#719
developerjamiu merged 5 commits into
mainfrom
concepts-phase3-section6-scheduling

Conversation

@developerjamiu

Copy link
Copy Markdown
Contributor

Summary

Section-by-section rework of the Scheduling (future calls) concept pages for Serverpod 4.0, following the same pattern as the Data & the database (#696) and Web server (#711) passes. Adds a section overview and brings every page current with the 4.0 API, verified against the framework source.

Changes

  • New Overview page. The section now opens with a landing page: what a future call is, the three scheduling shapes, the at-least-once execution guarantee, and the run-mode facts. Inbound links retarget here.
  • Future calls (was Setup): explains the generated .example accessor, uses the standard serverpod start / serverpod generate framing, and corrects the UTC behavior of callAtTime.
  • Recurring tasks (rewritten): documents the native callRecurring().cron() / .every() API, which was previously undocumented. Cron schedules are noted as UTC. The manual self-reschedule pattern is kept as a short fallback for dynamically computed intervals.
  • Inheritance (reframed): centers the real use case of a module exposing future calls through an abstract base, and fixes an example that claimed to share behavior through super.
  • Configuration: options table, corrected concurrency semantics (0 also means unlimited), and a corrected note that --role maintenance executes due calls rather than only checking for broken ones.
  • Legacy: states the @Deprecated status of the string-based scheduling methods precisely.

Notes

  • Execution is at-least-once (not exactly-once); the previous wording overstated the guarantee.
  • All framework claims verified against 4.0.0-beta.0.

@developerjamiu developerjamiu self-assigned this Jul 27, 2026
@developerjamiu developerjamiu added the documentation Improvements or additions to documentation label Jul 27, 2026
@developerjamiu
developerjamiu requested a review from Zfinix July 27, 2026 09:53

@Zfinix Zfinix left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The two renamed URLs here need redirects too, same list as the testing PR.

Comment thread docs/06-concepts/06-scheduling/03-recurring-tasks.md Outdated
Comment thread docs/06-concepts/06-scheduling/05-configuration.md
Comment thread docs/06-concepts/06-scheduling/05-configuration.md Outdated
Comment thread docs/06-concepts/06-scheduling/02-future-calls.md
Comment thread docs/06-concepts/06-scheduling/02-future-calls.md Outdated
Comment thread docs/06-concepts/06-scheduling/01-overview.md Outdated
@developerjamiu
developerjamiu requested a review from Zfinix July 28, 2026 09:10
Comment thread docs/06-concepts/06-scheduling/04-inheritance.md Outdated

@Zfinix Zfinix left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM 🚀 approved when the apostrophe is fixed.

@developerjamiu
developerjamiu merged commit 943eb9c into main Jul 28, 2026
4 checks passed
@developerjamiu
developerjamiu deleted the concepts-phase3-section6-scheduling branch July 28, 2026 09:34
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants