Skip to content

Commit c348267

Browse files
committed
docs: restructure introduction
Also fixed some links by moving the files.
1 parent ef2aae9 commit c348267

File tree

6 files changed

+143
-290
lines changed

6 files changed

+143
-290
lines changed

docs/src/modules/ROOT/nav.adoc

+3-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]

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,29 @@
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 less 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+
image::introduction/useCaseOverview.png[align="center"]
19+
20+
Timefold Solver is 100% pure Java^TM^ and runs on Java {java-version} or higher.
21+
It xref:integration/integration.adoc#integration[integrates very easily] with other Java^TM^, Python and other technologies.
22+
Timefold Solver works on any Java Virtual Machine and is compatible with the major JVM languages and all major platforms.
23+
It also supports Kotlin and Python.
24+
25+
:!sectnums:
26+
== Next
27+
28+
* Follow the xref:quickstart/overview.adoc[Quickstart Example] to tackle your first planning problem.
29+
* 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)