-
Notifications
You must be signed in to change notification settings - Fork 94
Closed
Labels
Type: DocumentationThis issue requires changes to the documentationThis issue requires changes to the documentation
Milestone
Description
For JuMP 1.0, I think we should add the solver READMEs to the documentation. Something like this (I mocked it up for MOI, but it should be for JuMP):
This requires a 1.0 tag for each solver first so the API is stable. We don't want to release JuMP with the documentation baked in, and then releases a breaking version of the solver so that the documentation is out-of-date.
In doing so, we should standardize the README for each solver. At the moment solver documentation is lacking, and things like setting options aren't uniformly well documented. If the solver has proper documentation that's okay, the README can just link to that.
frapac and blegat
Metadata
Metadata
Assignees
Labels
Type: DocumentationThis issue requires changes to the documentationThis issue requires changes to the documentation