docs: Introduce initial docs for service module (Preview)

[TomCools]

Currently providing this PR in DRAFT as a preview of the changes to come. Some content still needs validation and review from my side: e.g. going through the quickstart guide myself again and updating some references, after the service module has been officially released.

We have introduced the "Service" module, but this did not contain any documentation yet.

This PR will:

• Label some existing pages to be reworked (frontmatter data, no further impact)
• Introduce a new navigation item: Building a service (Preview)
• Introduce a couple of pages which describe basic service capabilities
• Introduce a new quickstart explicitly built using the service module, and reworked some of the shared files to avoid too much duplication across quickstarts.
• Rework the quickstart page to mention the distinction between using the solver as a library vs a service

[triceo]

Some notes after a first quick look.

[triceo]

Is this a third thing? "core", "service" and "raw"?

[TomCools]

raw => Core + Quarkus plugin integration. That should be clarified. It's the weird double right now.

[triceo]

I never much liked copy-pasting stuff from production code. Gets quickly outdated and forgotten about, until some user points it out.

Any chance we could have a live mechanism to point to an authoritative piece of source code, such as one in the quickstarts repo?

[TomCools]

Under investigation ;) We have a similar problem for all of the quickstarts btw.

[oemebamo]

I know this is a draft pr, but already some quick comments.

Great work @TomCools ❤️

[oemebamo]

Folder name "mdk" to be updated?

[oemebamo]

:relevance: is just something internal? an annotation? or does it trigger something automatically?

[TomCools]

Doesn't trigger anything, just metadata for me while refactoring the docs, so i don't have to keep a separate file with this info.

[oemebamo]

PP: Dataset optimization

[TomCools]

Moving this to a full PR (no longer draft). I have added tickets for most tasks, still left a few TODOs in the code (which doesn't get rendered.

[TomCools]

I remembered I still need to update some of the maven dependencies and links after the final merge, so making it draft again.

[Copilot]

Pull request overview

This draft PR introduces initial documentation for the new “Service” module (Preview), adds navigation and quickstart content for running Timefold Solver as an isolated optimization service, and annotates existing docs pages with metadata intended to guide future service-vs-library refactoring.

Changes:

• Add a new “Building a service (Preview)” documentation section covering REST API, model enrichment, constraint weight overrides, demo data, and metrics.
• Introduce a new “Run as a service (Preview)” quickstart and restructure the quickstart overview/navigation to distinguish library embedding vs service deployment.
• Add :relevance:/:notes: metadata to a number of existing pages to flag future content splits/rework.

Reviewed changes

Copilot reviewed 29 out of 30 changed files in this pull request and generated 9 comments.

Show a summary per file

File	Description
docs/src/modules/ROOT/pages/using-timefold-solver/running-the-solver.adoc	Adds service-vs-core relevance metadata to the “Running the solver” page.
docs/src/modules/ROOT/pages/using-timefold-solver/overview.adoc	Adds relevance metadata to indicate shared applicability across library/service.
docs/src/modules/ROOT/pages/using-timefold-solver/modeling-planning-problems.adoc	Adds relevance metadata and notes about shared vs service-specific modeling.
docs/src/modules/ROOT/pages/using-timefold-solver/configuration.adoc	Marks configuration docs as core-only via relevance metadata.
docs/src/modules/ROOT/pages/using-timefold-solver/benchmarking-and-tweaking.adoc	Adds relevance metadata to indicate partial applicability in service mode.
docs/src/modules/ROOT/pages/service/rest-api.adoc	New service REST API documentation (generated endpoints, request/response envelope, OpenAPI, validation, etc.).
docs/src/modules/ROOT/pages/service/overview.adoc	New top-level “Building a service (Preview)” landing page tying service docs to core concepts.
docs/src/modules/ROOT/pages/service/modeling-changes.adoc	New documentation on service-specific modeling concepts (SolverModel, enrichers, enrichment director).
docs/src/modules/ROOT/pages/service/exposing-metrics.adoc	New documentation for exposing input/output metrics via the service REST API.
docs/src/modules/ROOT/pages/service/demo-data.adoc	New documentation for exposing demo data endpoints via a DemoDataGenerator.
docs/src/modules/ROOT/pages/service/constraint-weights.adoc	New documentation describing ModelConfigOverrides and constraint weight overrides in service mode.
docs/src/modules/ROOT/pages/service/_preview-note.adoc	Adds a shared preview note included by service pages.
docs/src/modules/ROOT/pages/responding-to-change/responding-to-change.adoc	Adds relevance metadata noting service-vs-library differences.
docs/src/modules/ROOT/pages/quickstart/shared/school-timetabling/_school-timetabling-solution.adoc	Refactors repeated content into shared include files to reduce duplication.
docs/src/modules/ROOT/pages/quickstart/shared/school-timetabling/_school-timetabling-solution-value-range-providers.adoc	New shared include covering value range providers.
docs/src/modules/ROOT/pages/quickstart/shared/school-timetabling/_school-timetabling-solution-facts-and-entities.adoc	New shared include covering problem facts vs planning entities.
docs/src/modules/ROOT/pages/quickstart/shared/school-timetabling/_school-timetabling-model.adoc	Updates quickstart model docs (including switching Room example to a Java record).
docs/src/modules/ROOT/pages/quickstart/shared/school-timetabling/_school-timetabling-constraints.adoc	Updates constraint intro and links for the quickstart.
docs/src/modules/ROOT/pages/quickstart/shared/_whatyoubuild.adoc	Rewords “What you will build” to be less REST/service-specific.
docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc	New quickstart for building and running a service-based optimization model (Preview).
docs/src/modules/ROOT/pages/quickstart/overview.adoc	Reworks quickstart overview to compare “library” vs “service” approaches and introduce the new service quickstart.
docs/src/modules/ROOT/pages/optimization-algorithms/overview.adoc	Adds relevance metadata indicating applicability to both library and service usage.
docs/src/modules/ROOT/pages/introduction.adoc	Adds relevance metadata and notes to support future library-vs-service clarification.
docs/src/modules/ROOT/pages/integration/integration.adoc	Adds relevance metadata and notes about needed updates for service integration.
docs/src/modules/ROOT/pages/frequently-asked-questions.adoc	Adds relevance metadata.
docs/src/modules/ROOT/pages/design-patterns/design-patterns.adoc	Adds relevance metadata and internal notes about future restructuring.
docs/src/modules/ROOT/pages/constraints-and-score/overview.adoc	Adds relevance metadata for shared applicability.
docs/src/modules/ROOT/pages/constraints-and-score/constraint-configuration.adoc	Adds relevance metadata and notes about service-specific patterns.
docs/src/modules/ROOT/nav.adoc	Updates navigation to introduce “Run as a service (Preview)” and a library/service split in Getting Started, plus a new service docs subtree.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud