TimefoldAI / TimefoldAI/timefold-solver
Improvement: neighborhoods documentation
Open
Beginner friendly
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 felt that agents are currently not creating Neighborhoods API examples correctly. This is probably due to a lack of examples and explanation in the docs.
We should improve this.
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 Neighborhoods API documentation and reviewing any existing examples for the relevant Java APIs. Improve the explanations and add correct Neighborhoods examples; the work is done when agents can use the documentation to create Neighborhoods API examples correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100