Skip to content

Commit 6f5f54f

Browse files
authored
docs: restructure introduction (#1151)
Brought the documentation more in line with the other documentation elements. - Shortened the introduction page - Introduced the same PlanningAI Concepts page as on other sites (minus the reference to the platform). This was originally also in the "introduction" - Introduced an FAQ to place information which people will look for (like the licensing). Good place to add additional things Sales get asked about often. Also removed from the introduction page: - The list of different Use Cases. While that is somewhat valuable, i'd like to re-introduce those in the form of images. I left the current image which already shows 4 use-cases. Longer term, let's introduce an "Example Use Cases" heading to the documentation where we make these shine a bit more. - Note on Backwards Compatibility. I think this does not belong in an Intro. I have removed it for now as I think the expectation is always that this information should flow through the Changelog. - How to use Timefold Solver => Should be part of the quickstarts, so pushing people to the quickstarts sooner.
1 parent 228d282 commit 6f5f54f

8 files changed

+183
-291
lines changed

docs/src/modules/ROOT/nav.adoc

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
* xref:introduction/introduction.adoc[leveloffset=+1]
2-
* Quickstart
1+
* xref:introduction.adoc[leveloffset=+1]
2+
* Getting Started
33
** xref:quickstart/overview.adoc[leveloffset=+1]
44
** xref:quickstart/hello-world/hello-world-quickstart.adoc[leveloffset=+1]
55
** xref:quickstart/quarkus/quarkus-quickstart.adoc[leveloffset=+1]
66
** xref:quickstart/spring-boot/spring-boot-quickstart.adoc[leveloffset=+1]
77
** xref:quickstart/quarkus-vehicle-routing/quarkus-vehicle-routing-quickstart.adoc[leveloffset=+1]
8+
* xref:planning-ai-concepts.adoc[leveloffset=+1]
89
* Using Timefold Solver
910
** xref:using-timefold-solver/overview.adoc[leveloffset=+1]
1011
** xref:using-timefold-solver/configuration.adoc[leveloffset=+1]
@@ -32,4 +33,5 @@
3233
** xref:upgrading-timefold-solver/overview.adoc[leveloffset=+1]
3334
** xref:upgrading-timefold-solver/upgrade-to-latest-version.adoc[leveloffset=+1]
3435
** xref:upgrading-timefold-solver/upgrade-from-optaplanner.adoc[leveloffset=+1]
36+
** xref:upgrading-timefold-solver/backwards-compatibility.adoc[leveloffset=+1]
3537
* xref:enterprise-edition/enterprise-edition.adoc[leveloffset=+1]

docs/src/modules/ROOT/pages/.index.adoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,15 @@ ifndef::backend-pdf[]
1818
image::shared/timefold-logo.png[align="center"]
1919
endif::[]
2020

21-
include::introduction/introduction.adoc[leveloffset=+1]
21+
include::introduction.adoc[leveloffset=+1]
2222
include::quickstart/.quickstart.adoc[leveloffset=+1]
23+
include::planning-ai-concepts.adoc[leveloffset=+1]
2324
include::using-timefold-solver/.using-timefold-solver.adoc[leveloffset=+1]
2425
include::constraints-and-score/.constraints-and-score.adoc[leveloffset=+1]
2526
include::optimization-algorithms/.optimization-algorithms.adoc[leveloffset=+1]
2627
include::responding-to-change/responding-to-change.adoc[leveloffset=+1]
2728
include::integration/integration.adoc[leveloffset=+1]
2829
include::design-patterns/design-patterns.adoc[leveloffset=+1]
30+
include::frequently-asked-questions.adoc[leveloffset=+1]
2931
include::upgrading-timefold-solver/.upgrading-timefold-solver.adoc[leveloffset=+1]
3032
include::enterprise-edition/enterprise-edition.adoc[leveloffset=+1]
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
= FAQ
2+
:doctype: book
3+
:icons: font
4+
5+
== How is Timefold Solver Licensed?
6+
7+
Timefold Solver Community Edition is _open source_ software,
8+
released under http://www.apache.org/licenses/LICENSE-2.0.html[the Apache License 2.0].
9+
This license is very liberal and allows reuse for commercial purposes.
10+
Read http://www.apache.org/foundation/licence-FAQ.html#WhatDoesItMEAN[the layman's explanation].
11+
12+
Timefold Solver Enterprise Edition is a commercial product
13+
that offers xref:enterprise-edition/enterprise-edition.adoc#enterpriseEditionFeatures[additional features]
14+
to scale out to very large datasets.
15+
To find out more, see xref:enterprise-edition/enterprise-edition.adoc[Enterprise Edition section] of this documentation.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
[#introduction]
2+
:page-aliases: ../index.adoc
3+
:doctype: book
4+
:sectnums:
5+
:icons: font
6+
7+
[#whatIsTimefold]
8+
= What is Timefold Solver?
9+
10+
Every organization faces planning problems: providing products or services with a limited set of _constrained_ resources (employees, assets, time, and money).
11+
Timefold Solver’s xref:planning-ai-concepts.adoc[PlanningAI] optimizes these problems to do more business with fewer resources using Constraint Satisfaction Programming.
12+
13+
> Want to dive right into it? Follow our xref:quickstart/overview.adoc[Quickstart Example] to tackle your first planning problem in minutes.
14+
15+
https://timefold.ai[Timefold Solver] is a lightweight, embeddable constraint satisfaction engine which optimizes planning problems.
16+
Example usecases include:
17+
18+
.Timefold Solver's use cases include vehicle routing, employee scheduling, rostering, bin packing, and equipment scheduling.
19+
image::introduction/useCaseOverview.png[align="center"]
20+
21+
Timefold Solver is 100% pure Java^TM^ and runs on Java {java-version} or higher.
22+
It xref:integration/integration.adoc#integration[integrates very easily] with other Java^TM^, Python, and other technologies.
23+
Timefold Solver works on any Java Virtual Machine and is compatible with the major JVM languages and all major platforms.
24+
It also supports Kotlin and Python.
25+
26+
:!sectnums:
27+
== Next
28+
29+
* Follow the xref:quickstart/overview.adoc[Quickstart Example] to tackle your first planning problem.
30+
* Learn about some important concepts used in the realm of xref:planning-ai-concepts.adoc[PlanningAI].

docs/src/modules/ROOT/pages/introduction/introduction.adoc

-287
This file was deleted.

0 commit comments

Comments
 (0)