docs: description lists#2453
Merged
Merged
Conversation
Tries the suggestion: TimefoldAI#2416
Contributor
Author
|
@triceo doesn't look bad, what do you think? e.g. https://2c2d4d95.timefold-docs.pages.dev/timefold-solver/latest/constraints-and-score/overview |
Collaborator
|
I like it, @TomCools. |
triceo
approved these changes
Jul 2, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates several documentation pages to replace certain bulleted “term: description” lists with Asciidoctor description lists (term:: description), as an experiment aligned with issue #2416 to evaluate how these render in the docs pipeline.
Changes:
- Convert multiple term-like bullet lists into description lists for improved semantics and scanning (logging levels, metrics, supported options, method overviews).
- Preserve multi-line/nested explanations by using list continuations (
+) and open blocks (--) where needed. - Expand the previously terse “Pareto scoring” entry into an explicit description list item.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/src/modules/ROOT/pages/running-timefold-solver/solver-diagnostics.adoc | Converts logging levels and metric name lists to description lists. |
| docs/src/modules/ROOT/pages/running-timefold-solver/multithreaded-solving.adoc | Converts strategy/option lists to description lists and preserves sub-notes via continuations. |
| docs/src/modules/ROOT/pages/running-timefold-solver/benchmarking-and-tweaking.adoc | Converts “useful to” items and BenchmarkAggregator method list to description lists. |
| docs/src/modules/ROOT/pages/frequently-asked-questions.adoc | Converts infrastructure sizing guidance into description list items with open blocks for nested bullets. |
| docs/src/modules/ROOT/pages/constraints-and-score/overview.adoc | Converts score technique and score calculation type lists to description lists, including an expanded Pareto item. |
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.
Tries the suggestion: #2416
using some AI tokens to try these description lists