Skip to content

docs: description lists#2453

Merged
triceo merged 2 commits into
TimefoldAI:mainfrom
TomCools:docs/description
Jul 2, 2026
Merged

docs: description lists#2453
triceo merged 2 commits into
TimefoldAI:mainfrom
TomCools:docs/description

Conversation

@TomCools

@TomCools TomCools commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Tries the suggestion: #2416
using some AI tokens to try these description lists

@TomCools

TomCools commented Jul 1, 2026

Copy link
Copy Markdown
Contributor Author

@triceo

triceo commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

I like it, @TomCools.

@TomCools TomCools marked this pull request as ready for review July 2, 2026 08:33
@TomCools TomCools requested a review from triceo as a code owner July 2, 2026 08:33
Copilot AI review requested due to automatic review settings July 2, 2026 08:33

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

@triceo triceo merged commit 07fdf04 into TimefoldAI:main Jul 2, 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