From 961e62253a3936d0efce359c6c8a7ca16c6c5002 Mon Sep 17 00:00:00 2001 From: ArnoStrouwen Date: Tue, 2 Aug 2022 04:05:45 +0200 Subject: [PATCH 1/3] More docs unification --- docs/pages.jl | 3 +-- docs/src/index.md | 17 ++++++++++------- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/pages.jl b/docs/pages.jl index 8de820131..784411c0f 100644 --- a/docs/pages.jl +++ b/docs/pages.jl @@ -1,7 +1,6 @@ # Put in a separate page so it can be used by SciMLDocs.jl -pages = [ - "Home" => "index.md", +pages = ["index.md", "Tutorials" => Any["tutorials/nonlinear.md", "tutorials/iterator_interface.md"], "Basics" => Any["basics/NonlinearProblem.md", diff --git a/docs/src/index.md b/docs/src/index.md index 945ce870a..749298155 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,6 +1,6 @@ -# NonlinearSolve.jl: High-Performance Unified Nonlinear Solvers +# Overview -NonlinearSolve.jl is a unified interface for the nonlinear solving packages of +NonlinearSolve.jl is a high-performance unified interface for the nonlinear solving packages of Julia. It includes its own high-performance nonlinear solvers which include the ability to swap out to fast direct and iterative linear solvers, along with the ability to use sparse automatic differentiation for Jacobian construction and @@ -30,12 +30,15 @@ Pkg.add("NonlinearSolve") - Please refer to the [SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://github.com/SciML/ColPrac/blob/master/README.md) - for guidance on PRs, issues, and other matters relating to contributing to ModelingToolkit. + for guidance on PRs, issues, and other matters relating to contributing to SciML. +- See the [SciML Style Guide](https://github.com/SciML/SciMLStyle) for common coding practices and other style decisions. - There are a few community forums: - - the #diffeq-bridged channel in the [Julia Slack](https://julialang.org/slack/) - - [JuliaDiffEq](https://gitter.im/JuliaDiffEq/Lobby) on Gitter - - on the Julia Discourse forums (look for the [modelingtoolkit tag](https://discourse.julialang.org/tag/modelingtoolkit) - - see also [SciML Community page](https://sciml.ai/community/) + - The #diffeq-bridged and #sciml-bridged channels in the + [Julia Slack](https://julialang.org/slack/) + - The #diffeq-bridged and #sciml-bridged channels in the + [Julia Zulip](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged) + - On the [Julia Discourse forums](https://discourse.julialang.org) + - See also [SciML Community page](https://sciml.ai/community/) ## Roadmap From dae1aa94964524c40ffdcb11b6c78c5f764e2555 Mon Sep 17 00:00:00 2001 From: ArnoStrouwen Date: Tue, 2 Aug 2022 15:19:04 +0200 Subject: [PATCH 2/3] revert doc title --- docs/pages.jl | 3 ++- docs/src/index.md | 4 ++-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/pages.jl b/docs/pages.jl index 784411c0f..99b13f36b 100644 --- a/docs/pages.jl +++ b/docs/pages.jl @@ -1,6 +1,7 @@ # Put in a separate page so it can be used by SciMLDocs.jl -pages = ["index.md", +pages = [ + "Overview" => "index.md", "Tutorials" => Any["tutorials/nonlinear.md", "tutorials/iterator_interface.md"], "Basics" => Any["basics/NonlinearProblem.md", diff --git a/docs/src/index.md b/docs/src/index.md index 749298155..1118ef667 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,6 +1,6 @@ -# Overview +# NonlinearSolve.jl: High-Performance Unified Nonlinear Solvers -NonlinearSolve.jl is a high-performance unified interface for the nonlinear solving packages of +NonlinearSolve.jl is a unified interface for the nonlinear solving packages of Julia. It includes its own high-performance nonlinear solvers which include the ability to swap out to fast direct and iterative linear solvers, along with the ability to use sparse automatic differentiation for Jacobian construction and From 72433157dc25899321051f53aab14a063f155868 Mon Sep 17 00:00:00 2001 From: ArnoStrouwen Date: Mon, 15 Aug 2022 03:26:53 +0200 Subject: [PATCH 3/3] title SEO --- docs/pages.jl | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/pages.jl b/docs/pages.jl index 99b13f36b..784411c0f 100644 --- a/docs/pages.jl +++ b/docs/pages.jl @@ -1,7 +1,6 @@ # Put in a separate page so it can be used by SciMLDocs.jl -pages = [ - "Overview" => "index.md", +pages = ["index.md", "Tutorials" => Any["tutorials/nonlinear.md", "tutorials/iterator_interface.md"], "Basics" => Any["basics/NonlinearProblem.md",