Skip to content

docs: link getting started structure#2459

Merged
triceo merged 3 commits into
TimefoldAI:mainfrom
TomCools:docs/link-getting-started
Jul 3, 2026
Merged

docs: link getting started structure#2459
triceo merged 3 commits into
TimefoldAI:mainfrom
TomCools:docs/link-getting-started

Conversation

@TomCools

@TomCools TomCools commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

This resolved 2 items:

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 new getting-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.

Comment thread docs/src/modules/ROOT/pages/quickstart/service/getting-started.adoc

@triceo triceo left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM when Copilot comments resolved.

@triceo triceo merged commit a812d18 into TimefoldAI:main Jul 3, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants