Solver revamp docs folder and formatter

Author: abelsiqueira

.JuliaFormatter.toml

@@ -0,0 +1,7 @@
+margin = 100
+indent = 2
+whitespace_typedefs = true
+whitespace_ops_in_indices = true
+remove_extra_newlines = true
+annotate_untyped_fields_with_any = false
+normalize_line_endings = "unix"

docs/make.jl

@@ -5,16 +5,16 @@ makedocs(
   doctest = true,
   linkcheck = true,
   strict = true,
-  format = Documenter.HTML(assets = ["assets/style.css"], prettyurls = get(ENV, "CI", nothing) == "true"),
+  format = Documenter.HTML(
+    assets = ["assets/style.css"],
+    prettyurls = get(ENV, "CI", nothing) == "true",
+  ),
   sitename = "SolverCore.jl",
-  pages = ["Home" => "index.md",
-           "API" => "api.md",
-           "Reference" => "reference.md",
-          ]
+  pages = ["Home" => "index.md", "Reference" => "reference.md"],
 )
 
 deploydocs(
   repo = "github.com/JuliaSmoothOptimizers/SolverCore.jl.git",
   push_preview = true,
-  devbranch = "master"
+  devbranch = "master",
 )

docs/src/api.md

@@ -1,3 +1,9 @@
 # [SolverCore.jl documentation](@id Home)
 
-Core package to build novel optimization algorithms in Julia.
+Core package to build JSO-compliant solvers in Julia.
+
+---
+
+This package is extended for specific problem types:
+- **OptSolver.jl**: For optimization problems
+- **LinearSolvers.jl**: For linear solvers.

docs/src/index.md

@@ -1,4 +1,17 @@
 # Reference
 
+## Contents
+
+```@contents
+Pages = ["reference.md"]
+```
+
+## Index
+
 ```@index
+Pages = ["reference.md"]
 ```
+
+```@autodocs
+Modules = [SolverCore]
+```