Skip to content

docs: change constraint-overrides to module configuration overrides - #2501

Merged
triceo merged 10 commits into
TimefoldAI:mainfrom
TomCools:docs/2347
Jul 17, 2026
Merged

docs: change constraint-overrides to module configuration overrides#2501
triceo merged 10 commits into
TimefoldAI:mainfrom
TomCools:docs/2347

Conversation

@TomCools

Copy link
Copy Markdown
Contributor

Solves #2347

@rsynek , since this is Service heavy, might need your eyes on this.

@TomCools
TomCools requested a review from rsynek July 15, 2026 10:11
@TomCools
TomCools requested a review from triceo as a code owner July 15, 2026 10:11
Copilot AI review requested due to automatic review settings July 15, 2026 10:11
@TomCools
TomCools had a problem deploying to documentation (preview) July 15, 2026 10:11 — with GitHub Actions Failure
@TomCools
TomCools had a problem deploying to documentation (preview) July 15, 2026 10:12 — with GitHub Actions Failure
@TomCools TomCools added the component/docs Improvements or additions to documentation label Jul 15, 2026

Copilot AI 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.

Pull request overview

Updates the Service documentation to generalize “constraint weight overrides” into broader “model configuration overrides”, including both per-constraint weights and per-constraint parameters, aligning with the request-scoped ModelConfigOverrides/@ConstraintReference mechanism.

Changes:

  • Added a new Service doc page describing ModelConfigOverrides, @ConstraintReference (weight + parameter modes), and how to apply overrides in ModelConvertor.
  • Removed the old “Adjusting constraint weights” Service page and replaced the navigation entry to point at the new page.
  • Kept legacy routing intent via :page-aliases: (but requires an additional alias to preserve existing xrefs).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
docs/src/modules/ROOT/pages/running-timefold-solver/service/model-config-overrides.adoc New consolidated documentation for per-request model configuration overrides (weights + parameters).
docs/src/modules/ROOT/pages/running-timefold-solver/service/constraint-overrides.adoc Removed legacy constraint-weight-only page in favor of the consolidated replacement.
docs/src/modules/ROOT/nav.adoc Updates Service navigation to link to the new consolidated page.

Copilot AI review requested due to automatic review settings July 15, 2026 10:15

Copilot AI 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.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Comment thread docs/src/modules/ROOT/nav.adoc Outdated
Copilot AI review requested due to automatic review settings July 15, 2026 10:20

Copilot AI 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.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated no new comments.

Copilot AI 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.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated no new comments.

@rsynek rsynek 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.

Looks very good. Let me know what you think about the global parameters.

Copilot AI 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.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

Copilot AI 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.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.

Copilot AI review requested due to automatic review settings July 16, 2026 12:50

Copilot AI 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.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

@rsynek

rsynek commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

@TomCools please check the outstanding Copilot comments. Otherwise looks good, thanks!

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot AI 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.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Copilot AI review requested due to automatic review settings July 17, 2026 12:05
@triceo
triceo merged commit 176ef83 into TimefoldAI:main Jul 17, 2026
4 checks passed

Copilot AI 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.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.

Comment on lines +214 to +225
private static ConstraintParameters
getConstraintParameters(ModelConfig<MyPlanConfigOverrides> modelConfig) {

if (modelConfig.overrides() == null) {
return null;
}
MyPlanConfigOverrides overrides = modelConfig.overrides();
return new ConstraintParameters(
overrides.getBufferBeforeShiftEnd(),
overrides.getMinimumPriorityLevel()
);
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants