TimefoldAI / TimefoldAI/timefold-solver

docs: enhance migration path docs for variable listeners

Open
#1,835 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

component/docs
Dominant language
Java
Stars
1.8k
Forks
228
Avg merge
1d 13h
Merged PRs (30d)
46

Description

With the new approach to create shadow variables being promoted in the docs, we could add a section on the old VariableListeners on how to migrate some cases.

e.g.: Some people use the Working Solution in their variable listeners, to find some Problem Facts to calculate the shadow variables with. A fair mitigation would be to add those problem facts either on the Values or on the Entities themselves, depending on context.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the documentation sections covering shadow variables and the older VariableListeners approach, then compare how the existing migration guidance is organized. Add migration guidance for cases that use Working Solution problem facts, including the suggested placement on Values or Entities, and confirm the new section clearly explains when each approach applies.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.