Skip to content

docs: add kotlin code for service docs#2421

Merged
triceo merged 6 commits into
TimefoldAI:mainfrom
TomCools:docs/kotlin-service
Jun 26, 2026
Merged

docs: add kotlin code for service docs#2421
triceo merged 6 commits into
TimefoldAI:mainfrom
TomCools:docs/kotlin-service

Conversation

@TomCools

Copy link
Copy Markdown
Contributor

Solves: #2418

Not all Service pages had the Kotlin equivalent code examples yet.

@greyhairredbear could you do some Kotlin checking? Its been a while for me.

@TomCools TomCools requested a review from greyhairredbear June 25, 2026 12:40
@TomCools TomCools requested a review from triceo as a code owner June 25, 2026 12:41
Copilot AI review requested due to automatic review settings June 25, 2026 12:41
@TomCools TomCools added the component/docs Improvements or additions to documentation label Jun 25, 2026

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

This PR addresses issue #2418 by adding Kotlin equivalents to the Service documentation code examples, presented alongside existing Java snippets using tabbed AsciiDoc blocks.

Changes:

  • Introduces [tabs] sections to show Java and Kotlin examples side-by-side across Service docs pages.
  • Adds Kotlin example snippets for REST API setup/custom endpoints, modeling/enrichment, metrics, demo data, and constraint weight overrides.
  • Updates multiple pages to ensure Kotlin coverage is available on all relevant Service documentation topics.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
docs/src/modules/ROOT/pages/service/rest-api.adoc Adds tabbed Java/Kotlin REST API examples (DTO/resource, converter, validator, custom endpoints).
docs/src/modules/ROOT/pages/service/modeling-changes.adoc Adds tabbed Java/Kotlin examples for SolverModel and enrichment APIs.
docs/src/modules/ROOT/pages/service/exposing-metrics.adoc Adds tabbed Java/Kotlin examples for input/output metrics and combined metrics support.
docs/src/modules/ROOT/pages/service/demo-data.adoc Adds tabbed Java/Kotlin examples for implementing DemoDataGenerator.
docs/src/modules/ROOT/pages/service/constraint-weights.adoc Adds tabbed Java/Kotlin examples for constraint references and mapping overrides into solver config.

Comment thread docs/src/modules/ROOT/pages/service/rest-api.adoc
Comment thread docs/src/modules/ROOT/pages/service/rest-api.adoc
Comment thread docs/src/modules/ROOT/pages/service/rest-api.adoc
Comment thread docs/src/modules/ROOT/pages/service/rest-api.adoc
Comment thread docs/src/modules/ROOT/pages/service/rest-api.adoc
Comment thread docs/src/modules/ROOT/pages/service/demo-data.adoc
Comment thread docs/src/modules/ROOT/pages/service/demo-data.adoc
@greyhairredbear

Copy link
Copy Markdown
Contributor

On the TODO() remarks of Copilot: I like those a lot, leads to compilable code in the examples.

@greyhairredbear greyhairredbear 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.

Just a few minor comments. Feel free to ignore all of them, if you think that might be going into a bit too much detail or not be required yet.

Comment thread docs/src/modules/ROOT/pages/service/constraint-weights.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/service/exposing-metrics.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/service/exposing-metrics.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/service/modeling-changes.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/service/modeling-changes.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/service/modeling-changes.adoc
Comment thread docs/src/modules/ROOT/pages/service/rest-api.adoc

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

Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.

Comment thread docs/src/modules/ROOT/pages/service/modeling-changes.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/service/exposing-metrics.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/service/exposing-metrics.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/service/rest-api.adoc
Comment thread docs/src/modules/ROOT/pages/service/rest-api.adoc

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

Copilot reviewed 5 out of 5 changed files in this pull request and generated 4 comments.

Comment thread docs/src/modules/ROOT/pages/service/rest-api.adoc
Comment thread docs/src/modules/ROOT/pages/service/modeling-changes.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/service/exposing-metrics.adoc Outdated
Comment thread docs/src/modules/ROOT/pages/service/exposing-metrics.adoc Outdated

@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.

If Peter says the Kotlin bits are OK, I trust him.

@triceo triceo changed the title chore: add kotlin code for service docs. docs: add kotlin code for service docs Jun 26, 2026
@triceo triceo merged commit d76c96f into TimefoldAI:main Jun 26, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component/docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants