Repository navigation
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
Remaining documentation errors can leave copied build examples unusable and direct readers to incorrect setup guidance.
3 open issues
What changed in this PR
This PR corrects the getting-started guides so their Java and Kotlin examples better match the current solver APIs and application setup.
Changes:
- Fix build configuration, source links, file paths, and test examples.
- Align school-timetabling examples across Java, Kotlin, Spring Boot, and Quarkus.
- Update vehicle-routing JSON handling, driving-time initialization, and solver tests.
| File | Description |
|---|---|
| docs/src/modules/ROOT/pages/quickstart/spring-boot/spring-boot-quickstart.adoc | Corrects application setup, solver types, and REST tests. |
| docs/src/modules/ROOT/pages/quickstart/shared/school-timetabling/_school-timetabling-solution.adoc | Adds a score setter and corrects the Kotlin file path. |
| docs/src/modules/ROOT/pages/quickstart/shared/school-timetabling/_school-timetabling-model.adoc | Makes the test constructor public. |
| docs/src/modules/ROOT/pages/quickstart/shared/school-timetabling/_school-timetabling-constraints.adoc | Corrects Kotlin naming and simplifies constraints. |
| docs/src/modules/ROOT/pages/quickstart/shared/_solutionsourcecode.adoc | Adds optional Kotlin source links. |
| docs/src/modules/ROOT/pages/quickstart/shared/_java-logback-config.adoc | Corrects the resources directory path. |
| docs/src/modules/ROOT/pages/quickstart/shared/_constrainttests.adoc | Aligns Kotlin tests with the documented model. |
| docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc | Updates compiler setup, Kotlin constructors, and API-version guidance. |
| docs/src/modules/ROOT/pages/quickstart/quarkus/quarkus-quickstart.adoc | Corrects solver types, Kotlin examples, tests, and links. |
| docs/src/modules/ROOT/pages/quickstart/quarkus-vehicle-routing/vehicle-routing-solution.adoc | Extracts driving-time initialization for deserialized plans. |
| docs/src/modules/ROOT/pages/quickstart/quarkus-vehicle-routing/vehicle-routing-model.adoc | Updates JSON mapping, route calculations, and shadow-variable examples. |
| docs/src/modules/ROOT/pages/quickstart/quarkus-vehicle-routing/vehicle-routing-constraints.adoc | Updates penalty calls and Kotlin method visibility. |
| docs/src/modules/ROOT/pages/quickstart/quarkus-vehicle-routing/quarkus-vehicle-routing-quickstart.adoc | Updates build setup, initialization, and REST tests. |
| docs/src/modules/ROOT/pages/quickstart/hello-world/hello-world-quickstart.adoc | Adds JUnit setup and corrects Kotlin and constraint-test examples. |
| docs/src/modules/ROOT/pages/_attributes.adoc | Updates quickstart repository links. |
| docs/src/antora.yml | Exposes additional build-version attributes. |
Review effort: Balanced
Comment on lines
+17
to
+19
| assembly-plugin-version: ${version.assembly.plugin} | ||
| compiler-plugin-version: ${version.compiler.plugin} | ||
| junit-version: ${version.org.junit.jupiter} |
| `timefold.model.name` and the contact fields are *required* metadata. | ||
| `timefold.model.name`, `timefold.model.api-version` and the contact fields are *required* metadata. | ||
| Use a version such as `v1` for `timefold.model.api-version`. | ||
| It can only contain letters, numbers, hyphens (`-`) and underscores (`_`), so a value such as `1.0.0` fails the build. |
| endif::[] | ||
| ifndef::framework-kotlin-quickstart-url[] | ||
| In case you get stuck during this Getting Started guide, it might be worth checking the solution project {framework-quickstart-url}[on GitHub]. | ||
| endif::[] |
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@DedZago provided me a list of mistakes on the getting started pages.
These have now been processed.