docs: link getting started structure#2459
Merged
Merged
Conversation
9 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Quickstart documentation to match the new timefold-quickstarts repository structure and ensures the Service Getting Started guide ends with the missing OpenAPI-spec generation step.
Changes:
- Simplified the shared “Solution source code” section to point directly at the relevant solution project on GitHub via
{framework-quickstart-url}. - Updated the Service Getting Started guide to reuse the shared solution section and added instructions for generating the initial OpenAPI spec (
-Dupdate-api). - Repointed quickstart URL attributes (and added
:service-quickstart-url:) to the newgetting-started/...directory layout in the quickstarts repo.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/src/modules/ROOT/pages/quickstart/shared/_solutionsourcecode.adoc | Reworks the shared solution-reference section to link to the framework-specific quickstart repo location. |
| docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc | Switches to the shared solution section, sets a framework URL, and adds OpenAPI spec generation steps near the end. |
| docs/src/modules/ROOT/pages/_attributes.adoc | Updates quickstart link attributes to the new quickstarts repo structure and adds the service quickstart URL attribute. |
triceo
approved these changes
Jul 2, 2026
triceo
left a comment
Collaborator
There was a problem hiding this comment.
LGTM when Copilot comments resolved.
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.
This resolved 2 items: