Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
97 changes: 51 additions & 46 deletions docs/src/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,65 +1,70 @@
* xref:introduction.adoc[leveloffset=+1]
* xref:planning-ai-concepts.adoc[leveloffset=+1]
* Getting started
** xref:quickstart/overview.adoc[leveloffset=+1]
* xref:quickstart/overview.adoc[Getting started]
** xref:quickstart/service/getting-started.adoc[Build as a service]
** Embed as a library
*** xref:quickstart/hello-world/hello-world-quickstart.adoc[Hello World Guide]
*** xref:quickstart/quarkus/quarkus-quickstart.adoc[Quarkus Guide]
*** xref:quickstart/spring-boot/spring-boot-quickstart.adoc[Spring Boot Guide]
** xref:quickstart/service/getting-started.adoc[Run as a service (Preview)]
* Example use cases
** xref:quickstart/quarkus-vehicle-routing/quarkus-vehicle-routing-quickstart.adoc[Vehicle Routing (Guide)]
** https://github.com/TimefoldAI/timefold-quickstarts#-employee-scheduling[Employee Scheduling^]
** https://github.com/TimefoldAI/timefold-quickstarts#-maintenance-scheduling[Maintenance Scheduling^]
** https://github.com/TimefoldAI/timefold-quickstarts#-food-packaging[Food Packaging^]
** https://github.com/TimefoldAI/timefold-quickstarts#-order-picking[Order Picking^]
** https://github.com/TimefoldAI/timefold-quickstarts#-school-timetabling[School Timetabling^]
** https://github.com/TimefoldAI/timefold-quickstarts#-facility-location-problem[Facility Location^]
** https://github.com/TimefoldAI/timefold-quickstarts#-conference-scheduling[Conference Scheduling^]
** https://github.com/TimefoldAI/timefold-quickstarts#-bed-allocation-scheduling[Bed Allocation^]
** https://github.com/TimefoldAI/timefold-quickstarts#-flight-crew-scheduling[Flight Crew Scheduling^]
** https://github.com/TimefoldAI/timefold-quickstarts#-meeting-scheduling[Meeting Scheduling^]
** https://github.com/TimefoldAI/timefold-quickstarts#-task-assigning[Task Assigning^]
** https://github.com/TimefoldAI/timefold-quickstarts#-project-job-scheduling[Project Job Scheduling^]
** https://github.com/TimefoldAI/timefold-quickstarts#-sports-league-scheduling[Sports League Scheduling^]
** https://github.com/TimefoldAI/timefold-quickstarts#-tournament-scheduling[Tournament Scheduling^]
* Using Timefold Solver
** xref:using-timefold-solver/overview.adoc[leveloffset=+1]
** xref:using-timefold-solver/configuration.adoc[leveloffset=+1]
** xref:using-timefold-solver/modeling-planning-problems.adoc[leveloffset=+1]
** xref:using-timefold-solver/running-the-solver.adoc[leveloffset=+1]
** xref:using-timefold-solver/benchmarking-and-tweaking.adoc[leveloffset=+1]
** xref:service/overview.adoc[Building a service (Preview)]
*** xref:service/rest-api.adoc[leveloffset=+1]
*** xref:service/modeling-changes.adoc[leveloffset=+1]
*** xref:service/constraint-weights.adoc[leveloffset=+1]
*** xref:service/demo-data.adoc[leveloffset=+1]
*** xref:service/exposing-metrics.adoc[leveloffset=+1]
* Constraints and score
** xref:constraints-and-score/overview.adoc[leveloffset=+1]
*** xref:quickstart/hello-world/hello-world-quickstart.adoc[Hello World guide]
*** xref:quickstart/quarkus/quarkus-quickstart.adoc[Quarkus guide]
*** xref:quickstart/spring-boot/spring-boot-quickstart.adoc[Spring Boot guide]

* Domain modeling
** xref:running-timefold-solver/modeling-planning-problems.adoc[leveloffset=+1]
** xref:design-patterns/domain-modeling.adoc[leveloffset=+1]
** xref:design-patterns/time-patterns.adoc[leveloffset=+1]

* xref:constraints-and-score/overview.adoc[Constraints and score]
** xref:constraints-and-score/score-calculation.adoc[leveloffset=+1]
** xref:constraints-and-score/understanding-the-score.adoc[Understanding the score]
** xref:constraints-and-score/constraint-configuration.adoc[leveloffset=+1]
** xref:constraints-and-score/load-balancing-and-fairness.adoc[leveloffset=+1]
** xref:constraints-and-score/performance.adoc[leveloffset=+1]
* Optimization algorithms
** xref:optimization-algorithms/overview.adoc[leveloffset=+1]

* xref:running-timefold-solver/overview.adoc[Running the Solver]
** xref:service/overview.adoc[As a service]
*** xref:service/rest-api.adoc[leveloffset=+1]
*** xref:service/modeling-changes.adoc[leveloffset=+1]
*** xref:constraints-and-score/constraint-configuration.adoc#serviceWeightOverrides[Constraint weights]
*** xref:service/demo-data.adoc[leveloffset=+1]
*** xref:service/exposing-metrics.adoc[leveloffset=+1]
** xref:running-timefold-solver/library-integration.adoc[As a library]
*** xref:running-timefold-solver/configuration.adoc[leveloffset=+1]
*** xref:constraints-and-score/constraint-configuration.adoc#libraryWeightOverrides[Constraint weights]
*** xref:integration/quarkus.adoc[leveloffset=+1]
*** xref:integration/spring-boot.adoc[leveloffset=+1]
*** xref:integration/persistent-storage.adoc[leveloffset=+1]

* Diagnosing the Solver
** xref:running-timefold-solver/benchmarking-and-tweaking.adoc[leveloffset=+1]
** xref:running-timefold-solver/solver-diagnostics.adoc[leveloffset=+1]

* xref:optimization-algorithms/overview.adoc[Optimization algorithms]
** xref:optimization-algorithms/construction-heuristics.adoc[leveloffset=+1]
** xref:optimization-algorithms/local-search.adoc[leveloffset=+1]
** xref:optimization-algorithms/exhaustive-search.adoc[leveloffset=+1]
** xref:optimization-algorithms/neighborhoods.adoc[leveloffset=+1]
** xref:optimization-algorithms/move-selector-reference.adoc[leveloffset=+1]
** Custom moves
*** xref:optimization-algorithms/neighborhoods.adoc[Neighborhoods API]
*** xref:optimization-algorithms/move-selector-reference.adoc[leveloffset=+1]

* Deployment
** xref:deployment/cloud-architecture.adoc[leveloffset=+1]
** xref:deployment/infrastructure-requirements.adoc[leveloffset=+1]

* xref:responding-to-change/responding-to-change.adoc[leveloffset=+1]
* xref:integration/integration.adoc[leveloffset=+1]
* xref:design-patterns/design-patterns.adoc[leveloffset=+1]

* Example use cases
** xref:quickstart/quarkus-vehicle-routing/quarkus-vehicle-routing-quickstart.adoc[Vehicle routing (guide)]
** https://github.com/TimefoldAI/timefold-quickstarts[More examples on GitHub^]


* xref:frequently-asked-questions.adoc[leveloffset=+1]
* https://github.com/TimefoldAI/timefold-solver/releases[New and noteworthy][leveloffset=+1]

* Upgrading Timefold Solver
** xref:upgrading-timefold-solver/overview.adoc[leveloffset=+1]
** xref:upgrading-timefold-solver/upgrade-from-v1.adoc[leveloffset=+1]
** https://docs.timefold.ai/timefold-solver/1.x/upgrading-timefold-solver/upgrade-from-optaplanner[Upgrading from OptaPlanner][leveloffset=+1]
** xref:upgrading-timefold-solver/backwards-compatibility.adoc[leveloffset=+1]
** Migration Guides
** Migration guides
*** xref:upgrading-timefold-solver/migration-guides/variable-listeners-to-custom-shadow-variables.adoc[leveloffset=+1]
*** xref:upgrading-timefold-solver/migration-guides/chained-variables-to-planning-list-variable.adoc[leveloffset=+1]
* xref:commercial-editions/commercial-editions.adoc[leveloffset=+1]
Expand All @@ -68,8 +73,8 @@
** xref:constraints-and-score/understanding-the-score.adoc[Score analysis]
** xref:responding-to-change/responding-to-change.adoc#assignmentRecommendationAPI[Recommendation API]
** xref:optimization-algorithms/move-selector-reference.adoc#nearbySelection[Nearby selection]
** xref:using-timefold-solver/running-the-solver.adoc#multithreadedIncrementalSolving[Multithreaded solving]
** xref:using-timefold-solver/running-the-solver.adoc#partitionedSearch[Partitioned search]
** xref:running-timefold-solver/multithreaded-solving.adoc#multithreadedIncrementalSolving[Multithreaded solving]
** xref:running-timefold-solver/multithreaded-solving.adoc#partitionedSearch[Partitioned search]
** xref:constraints-and-score/performance.adoc#constraintProfiling[Constraint profiling]
** xref:commercial-editions/multistage-moves.adoc[leveloffset=+1]
** xref:using-timefold-solver/running-the-solver.adoc#throttlingBestSolutionEvents[Throttling best solution events]
** xref:running-timefold-solver/library-integration.adoc#throttlingBestSolutionEvents[Throttling best solution events]
2 changes: 1 addition & 1 deletion docs/src/modules/ROOT/pages/.index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ endif::[]
include::introduction.adoc[leveloffset=+1]
include::quickstart/.quickstart.adoc[leveloffset=+1]
include::planning-ai-concepts.adoc[leveloffset=+1]
include::using-timefold-solver/.using-timefold-solver.adoc[leveloffset=+1]
include::running-timefold-solver/.running-timefold-solver.adoc[leveloffset=+1]
include::constraints-and-score/.constraints-and-score.adoc[leveloffset=+1]
include::optimization-algorithms/.optimization-algorithms.adoc[leveloffset=+1]
include::responding-to-change/responding-to-change.adoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
:icons: font

_Timefold Solver Plus_ and _Timefold Solver Enterprise_ are commercial products which offer additional features,
such as xref:constraints-and-score/understanding-the-score.adoc[score analysis], xref:optimization-algorithms/move-selector-reference.adoc#nearbySelection[nearby selection] and xref:using-timefold-solver/running-the-solver.adoc#multithreadedIncrementalSolving[multithreaded solving].
such as xref:constraints-and-score/understanding-the-score.adoc[score analysis], xref:optimization-algorithms/move-selector-reference.adoc#nearbySelection[nearby selection] and xref:running-timefold-solver/multithreaded-solving.adoc#multithreadedIncrementalSolving[multithreaded solving].
These features are essential to scale out to large datasets and build trust with your users.

Unlike _Timefold Solver Community Edition_, these commercial editions are not open-source.
Expand Down Expand Up @@ -37,10 +37,10 @@ See our https://licenses.timefold.ai/[license portal] to get your license, then
| xref:optimization-algorithms/move-selector-reference.adoc#nearbySelection[Nearby selection]
| | ✓

| xref:using-timefold-solver/running-the-solver.adoc#multithreadedIncrementalSolving[Multithreaded solving]
| xref:running-timefold-solver/multithreaded-solving.adoc#multithreadedIncrementalSolving[Multithreaded solving]
| | ✓

| xref:using-timefold-solver/running-the-solver.adoc#partitionedSearch[Partitioned search]
| xref:running-timefold-solver/multithreaded-solving.adoc#partitionedSearch[Partitioned search]
| | ✓

| xref:constraints-and-score/performance.adoc#constraintProfiling[Constraint profiling]
Expand All @@ -49,7 +49,7 @@ See our https://licenses.timefold.ai/[license portal] to get your license, then
| xref:commercial-editions/multistage-moves.adoc[Multistage moves]
| | ✓

| xref:using-timefold-solver/running-the-solver.adoc#throttlingBestSolutionEvents[Throttling best solution events]
| xref:running-timefold-solver/library-integration.adoc#throttlingBestSolutionEvents[Throttling best solution events]
| | ✓

|===
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Timefold Solver Enterprise brings many performance improvements. These are short
include::./_only-enterprise.adoc[]

Updates to shadow variables happen incrementally with Timefold Solver Enterprise.
For models making intensive use of xref:using-timefold-solver/modeling-planning-problems.adoc#customShadowVariable[shadow variables], this should be visible as a serious performance improvement out-of-the-box.
For models making intensive use of xref:running-timefold-solver/modeling-planning-problems.adoc#customShadowVariable[shadow variables], this should be visible as a serious performance improvement out-of-the-box.

This is enabled by default and doesn't require any special considerations.

Expand Down
Loading