TimefoldAI / TimefoldAI/timefold-solver
Docs: Improve introduction / quickstart structure
Open
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.8k
- Forks
- 228
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 46
Description
The introduction to the Solver documentation is somewhat unstructured.
- Introduction already contains "Getting started" code examples.
- "Using the Solver" once again has an overview.
- Modelling and design patterns are not necessarily super Solver Specific and are mentioned both in the "Design Patterns" header AND under "Using Timefold solver -> Modelling planning problems"
Improve the structure so Introduction is just an introduction and links to all other aspects.
It should explain what it is and how to link through to other elements.
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 locating the Introduction, Getting started, Using the Solver, Modelling planning problems, and Design Patterns sections in the Solver documentation. Compare their current scope and links; done means Introduction is a concise overview that explains what Solver is and links clearly to the other aspects without duplicated examples or modelling guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100