Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: restructure introduction #1151

Merged
merged 1 commit into from
Oct 22, 2024
Merged
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
6 changes: 4 additions & 2 deletions docs/src/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
* xref:introduction/introduction.adoc[leveloffset=+1]
* Quickstart
* xref:introduction.adoc[leveloffset=+1]
* Getting Started
** xref:quickstart/overview.adoc[leveloffset=+1]
** xref:quickstart/hello-world/hello-world-quickstart.adoc[leveloffset=+1]
** xref:quickstart/quarkus/quarkus-quickstart.adoc[leveloffset=+1]
** xref:quickstart/spring-boot/spring-boot-quickstart.adoc[leveloffset=+1]
** xref:quickstart/quarkus-vehicle-routing/quarkus-vehicle-routing-quickstart.adoc[leveloffset=+1]
* xref:planning-ai-concepts.adoc[leveloffset=+1]
* Using Timefold Solver
** xref:using-timefold-solver/overview.adoc[leveloffset=+1]
** xref:using-timefold-solver/configuration.adoc[leveloffset=+1]
Expand Down Expand Up @@ -32,4 +33,5 @@
** xref:upgrading-timefold-solver/overview.adoc[leveloffset=+1]
** xref:upgrading-timefold-solver/upgrade-to-latest-version.adoc[leveloffset=+1]
** xref:upgrading-timefold-solver/upgrade-from-optaplanner.adoc[leveloffset=+1]
** xref:upgrading-timefold-solver/backwards-compatibility.adoc[leveloffset=+1]
* xref:enterprise-edition/enterprise-edition.adoc[leveloffset=+1]
4 changes: 3 additions & 1 deletion docs/src/modules/ROOT/pages/.index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,15 @@ ifndef::backend-pdf[]
image::shared/timefold-logo.png[align="center"]
endif::[]

include::introduction/introduction.adoc[leveloffset=+1]
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::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]
include::integration/integration.adoc[leveloffset=+1]
include::design-patterns/design-patterns.adoc[leveloffset=+1]
include::frequently-asked-questions.adoc[leveloffset=+1]
include::upgrading-timefold-solver/.upgrading-timefold-solver.adoc[leveloffset=+1]
include::enterprise-edition/enterprise-edition.adoc[leveloffset=+1]
15 changes: 15 additions & 0 deletions docs/src/modules/ROOT/pages/frequently-asked-questions.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
= FAQ
:doctype: book
:icons: font

== How is Timefold Solver Licensed?

Timefold Solver Community Edition is _open source_ software,
released under http://www.apache.org/licenses/LICENSE-2.0.html[the Apache License 2.0].
This license is very liberal and allows reuse for commercial purposes.
Read http://www.apache.org/foundation/licence-FAQ.html#WhatDoesItMEAN[the layman's explanation].

Timefold Solver Enterprise Edition is a commercial product
that offers xref:enterprise-edition/enterprise-edition.adoc#enterpriseEditionFeatures[additional features]
to scale out to very large datasets.
To find out more, see xref:enterprise-edition/enterprise-edition.adoc[Enterprise Edition section] of this documentation.
30 changes: 30 additions & 0 deletions docs/src/modules/ROOT/pages/introduction.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
[#introduction]
:page-aliases: ../index.adoc
:doctype: book
:sectnums:
:icons: font

[#whatIsTimefold]
= What is Timefold Solver?

Every organization faces planning problems: providing products or services with a limited set of _constrained_ resources (employees, assets, time, and money).
Timefold Solver’s xref:planning-ai-concepts.adoc[PlanningAI] optimizes these problems to do more business with fewer resources using Constraint Satisfaction Programming.

> Want to dive right into it? Follow our xref:quickstart/overview.adoc[Quickstart Example] to tackle your first planning problem in minutes.

https://timefold.ai[Timefold Solver] is a lightweight, embeddable constraint satisfaction engine which optimizes planning problems.
Example usecases include:

.Timefold Solver's use cases include vehicle routing, employee scheduling, rostering, bin packing, and equipment scheduling.
image::introduction/useCaseOverview.png[align="center"]

Timefold Solver is 100% pure Java^TM^ and runs on Java {java-version} or higher.
It xref:integration/integration.adoc#integration[integrates very easily] with other Java^TM^, Python, and other technologies.
Timefold Solver works on any Java Virtual Machine and is compatible with the major JVM languages and all major platforms.
It also supports Kotlin and Python.

:!sectnums:
== Next

* Follow the xref:quickstart/overview.adoc[Quickstart Example] to tackle your first planning problem.
* Learn about some important concepts used in the realm of xref:planning-ai-concepts.adoc[PlanningAI].
287 changes: 0 additions & 287 deletions docs/src/modules/ROOT/pages/introduction/introduction.adoc

This file was deleted.

Loading