TimefoldAI / TimefoldAI/timefold-solver
Docs: Terminology issue
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.8k
- Forks
- 228
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 46
Description
As mentioned by @triceo:
"Overconstrained planning" suffers of a problem that you will never find it if you're not specifically looking for it. It is a very common pattern, but nobody will actually type "overconstrained planning" in the search box, because nobody knows that that's what we're calling it. Our docs suffers from this heavily. "Termination" is another great example; unless you know to look for that word specifically, you are lost.
Let's find a way to fix this. Gut feeling says "FAQ", but it could also be a bit on "solver fundamentals" which explains the core concepts. That feels like it's missing currently.
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
Review the current documentation for the terms “overconstrained planning” and “termination” and assess how users would discover those concepts without knowing the terminology. Compare an FAQ approach with a solver fundamentals section. Done means the core concepts and alternate ways users might search for them are documented and discoverable.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100