Skip to content

docs: sync Immediate.Jobs through 1530bc1 - #19

Open
dukesteen wants to merge 5 commits into
mainfrom
docs/sync-immediate-jobs-2026-08-12
Open

docs: sync Immediate.Jobs through 1530bc1#19
dukesteen wants to merge 5 commits into
mainfrom
docs/sync-immediate-jobs-2026-08-12

Conversation

@dukesteen

@dukesteen dukesteen commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Sync Immediate.Jobs docs through 1530bc1 (range aebc7f3..1530bc1, 16 commits).
  • Update registration for IImmediateJobsBuilder, ConfigureWorkers, explicit storage selection, DisableWorkers, and configuration binding.
  • Update dashboard setup, security options, telemetry links, and the LinqToDB and Redis provider examples.
  • Document JobStorageConformanceSuite.AllCasesByName and correct a tagged-host example that could omit a job handler.
  • Review every changed page for dense or low-value wording. Keep API names, rules, and failure behavior while shortening the surrounding prose.

Source audit

Every commit in the range was reviewed. The first 15 commits were covered by earlier commits in this PR. They include namespace changes, the unused-queue diagnostic, named recurring-job triggers, repeat-safe registration, storage tests, the first builder API, JobMonitor, dashboard and Redis options, and dependency updates.

The new commit, 1530bc1, changes the public configuration API:

  • Generated AddXxxJobs methods now return IImmediateJobsBuilder.
  • Worker settings use ConfigureWorkers. Storage must be selected with ConfigureStorage.
  • DisableWorkers supports applications that enqueue or display jobs while another process runs them.
  • Dashboard registration now follows the jobs builder and uses ConfigureDashboard.
  • LinqToDB now resolves a registered DataConnection type. Redis now resolves a registered IConnectionMultiplexer and uses ConfigureRedis.
  • The storage test catalog now provides AllCasesByName.

Internal test organization and dependency-only changes do not need separate application guidance.

Validation

  • pnpm check
  • pnpm lint
  • pnpm build
  • dotnet build tests/Immediate.Jobs.StorageTests/Immediate.Jobs.StorageTests.csproj -v minimal on Immediate.Jobs 1530bc1
  • dotnet build samples/Basic/Basic.csproj -v minimal on Immediate.Jobs 1530bc1
  • git diff --check

All checks passed. The docs build reported its existing Vite chunk-size warning. The dashboard dependency audit reported 25 high-severity findings.

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: d573b097-a1a1-4c43-8f32-8e9412405aa4

📥 Commits

Reviewing files that changed from the base of the PR and between 4ba42f9 and 641813a.

📒 Files selected for processing (16)
  • src/content/docs/Immediate.Jobs/api-reference.md
  • src/content/docs/Immediate.Jobs/batches-and-continuations.md
  • src/content/docs/Immediate.Jobs/choosing-storage.md
  • src/content/docs/Immediate.Jobs/configuring-storage-providers.md
  • src/content/docs/Immediate.Jobs/dashboard-and-monitoring.md
  • src/content/docs/Immediate.Jobs/diagnostics.md
  • src/content/docs/Immediate.Jobs/enqueueing-and-scheduling.md
  • src/content/docs/Immediate.Jobs/how-it-works.md
  • src/content/docs/Immediate.Jobs/introduction.md
  • src/content/docs/Immediate.Jobs/nodatime.md
  • src/content/docs/Immediate.Jobs/observability-and-health.md
  • src/content/docs/Immediate.Jobs/queues-and-fairness.md
  • src/content/docs/Immediate.Jobs/recurring-jobs.md
  • src/content/docs/Immediate.Jobs/registration-and-hosting.md
  • src/content/docs/Immediate.Jobs/testing-jobs.md
  • src/content/docs/concepts/tags.md

📝 Walkthrough

Walkthrough

The documentation updates describe renamed batch APIs, generated recurring-job dispatch, fluent registration, storage topology and capabilities, health checks, diagnostics, fair queues, and provider conformance testing.

Changes

Immediate Jobs documentation

Layer / File(s) Summary
Public API and generated contracts
src/content/docs/Immediate.Jobs/api-reference.md, src/content/docs/Immediate.Jobs/batches-and-continuations.md, src/content/docs/Immediate.Jobs/dashboard-and-monitoring.md
The API reference documents renamed batch contracts, RecurringJobs, expanded builders, storage capabilities, and updated provider return types. Related batch and monitoring examples use the renamed interfaces.
Storage configuration and provider contracts
src/content/docs/Immediate.Jobs/choosing-storage.md, src/content/docs/Immediate.Jobs/configuring-storage-providers.md, src/content/docs/Immediate.Jobs/queues-and-fairness.md
Storage examples use ConfigureStorage and topology selection. Provider guidance defines capability contracts, defaults, and conformance requirements.
Registration, runtime validation, and health checks
src/content/docs/Immediate.Jobs/registration-and-hosting.md, src/content/docs/Immediate.Jobs/how-it-works.md, src/content/docs/Immediate.Jobs/observability-and-health.md, src/content/docs/Immediate.Jobs/diagnostics.md, src/content/docs/Immediate.Jobs/queues-and-fairness.md
Registration guidance documents fluent builder configuration, generated APIs, duplicate handling, startup validation, diagnostics, fair queues, and readiness health checks.
Job workflows and provider testing
src/content/docs/Immediate.Jobs/recurring-jobs.md, src/content/docs/Immediate.Jobs/enqueueing-and-scheduling.md, src/content/docs/Immediate.Jobs/testing-jobs.md, src/content/docs/Immediate.Jobs/introduction.md, src/content/docs/Immediate.Jobs/nodatime.md, src/content/docs/concepts/tags.md
Job examples use the updated registration and recurring-job APIs. Testing guidance documents harness-managed storage and capability-driven provider conformance tests.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies a documentation synchronization for Immediate.Jobs, which matches the main changes in the pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/sync-immediate-jobs-2026-08-12

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.

@dukesteen dukesteen changed the title docs: sync Immediate.Jobs through ee5f51d docs: sync Immediate.Jobs through 9c8c13b Aug 14, 2026
@dukesteen dukesteen changed the title docs: sync Immediate.Jobs through 9c8c13b docs: sync Immediate.Jobs through 618521a Aug 18, 2026
@dukesteen dukesteen changed the title docs: sync Immediate.Jobs through 618521a docs: sync Immediate.Jobs through 1530bc1 Aug 19, 2026
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