TimefoldAI / TimefoldAI/timefold-solver
docs: restructure shared information
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 have some shared information across Models / Platform and Solver docs. These include:
- Termination and how to configure it (https://docs.timefold.ai/field-service-routing/latest/user-guide/input-datasets/model-configuration)
- Waiting for results (polling vs SSE vs Webhooks), although that last one is specific to the platform.
- https://docs.timefold.ai/field-service-routing/latest/user-guide/input-datasets/model-configuration#_model Model overrides
Thise should be better aligned.
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 comparing the Model, Platform, and Solver documentation, especially the field-service-routing user-guide/input-datasets/model-configuration page and its Model overrides section. Review how termination, waiting for results, and model overrides are currently described, then align the shared information while keeping platform-specific polling, SSE, and webhook guidance distinct. Done means the related pages have consistent structure and no duplicated or conflicting guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100