TimefoldAI / TimefoldAI/timefold-solver
Docs: Improve mixed model documentation
Open
Nobody has claimed this yet.
component/docs
- Dominant language
- Java
- Stars
- 1.8k
- Forks
- 228
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 46
Description
We already have some documentation on the use of mixed models, but i can be improved.
e.g.
- What are the semantics of
@Pinnedand@PinnedtoIndexwhen using a mixed model? - How are these variables initialized? (I am seeing 2 construction heuristic phases)
- What pitfalls are there? (need more nudging of custom moves to not only change just 1 variable?)
- ....
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing mixed-model documentation and the behavior of @Pinned and @PinnedtoIndex. Document their semantics, variable initialization and construction heuristic phases, and pitfalls around custom moves; the work is done when these questions are clearly answered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100