Skip to content

Improve documentation for jobs#1126

Merged
rasmus merged 2 commits intodevelop-v1from
improve-docs-jobs
Oct 11, 2025
Merged

Improve documentation for jobs#1126
rasmus merged 2 commits intodevelop-v1from
improve-docs-jobs

Conversation

@rasmus
Copy link
Member

@rasmus rasmus commented Oct 11, 2025

No description provided.

Copilot AI review requested due to automatic review settings October 11, 2025 11:16
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR significantly improves the documentation for EventFlow's jobs feature by making it clearer, more comprehensive, and better structured. The updates modernize the language, add important warnings about default behavior, and provide more practical guidance.

Key Changes

  • Enhanced introduction with clearer explanations of job use cases and EventFlow's job system
  • Added critical warnings about the default InstantJobScheduler behavior and serialization requirements
  • Improved Hangfire integration section with production-ready configuration examples

.AddHangfireServer();
eventFlowOptions.UseHangfireJobScheduler();
eventFlowOptions.ServiceCollection
.AddHangfire(configuration => configuration.UseSqlServerStorage(connectionString))
Copy link

Copilot AI Oct 11, 2025

Choose a reason for hiding this comment

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

The connectionString variable is referenced but not defined in the example. Consider either defining it or using a placeholder like \"YourConnectionStringHere\" to make the example more complete.

Copilot uses AI. Check for mistakes.
@rasmus rasmus enabled auto-merge October 11, 2025 11:26
@rasmus rasmus disabled auto-merge October 11, 2025 11:37
@rasmus rasmus merged commit 2b86b56 into develop-v1 Oct 11, 2025
4 checks passed
@rasmus rasmus deleted the improve-docs-jobs branch October 11, 2025 11:37
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