Add more information to the documentation #333
Conversation
|
Removed citation section from the documentation.
|
Replaced LaTeX equation with plain text representation.
|
|
|
You can check the preview here: https://jso.dev/JSOSolvers.jl/previews/PR333/ @giovannifereoli |
|
You already explain this nicely in the paper - it’s just missing here in the docs. Adding a short sentence in the Statement of Need about why matrix-free optimization matters (e.g., large-scale problems, high-dimensional decision vectors, ML workflows where Hessians are impractical) would make the motivation clearer |
There was a problem hiding this comment.
Pull request overview
This PR enhances the documentation by adding more detailed information about JSOSolvers.jl, reorganizing content, and improving user guidance. The changes expand the introduction with mathematical formulation, motivation, and installation instructions, while moving tutorial references to a dedicated examples page.
- Expands the main documentation with mathematical problem formulation, solver approach description, and installation instructions
- Creates a new examples page for tutorials and learning resources
- Adds a documentation badge reference in the README
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/src/index.md | Adds mathematical formulation, solver description, installation section, and bug reporting guidelines; removes tutorials section |
| docs/src/examples.md | New file containing tutorial references and example resources |
| docs/make.jl | Registers the new examples.md page in the documentation structure |
| README.md | Adds reference to documentation badge for easier access |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <[email protected]>
|
|
|
|
Added explanation of function properties and optimization methods.
|
|
Hi @giovannifereoli The preview is here: https://jso.dev/JSOSolvers.jl/previews/PR333/ |
|
The documentation looks great now! Would you mind adding an extra link to the docs in the README or the repo description, so it’s easy to find even without clicking the badge? |
|
Heads up, I’m added an item to the checklist above regarding automated testing! |
| stats = lbfgs(nlp) # or trunk, tron, R2 | ||
| ``` | ||
|
|
||
| Click on the badge [](https://jso.dev/JSOSolvers.jl/stable) to access the documentation. |
There was a problem hiding this comment.
@giovannifereoli It was added here already, do you think of a better place ?
Preview: https://github.com/JuliaSmoothOptimizers/JSOSolvers.jl/blob/add-joss-comments-docs/README.md
|
Maybe something like this could work: DocumentationClick on the badge Just a personal preference! |
|
No description provided.