docs: add component READMEs to all sublibraries

ChrisRackauckas · claude · ChrisRackauckas · commit 936ebd1cfbd1 · 2026-06-07T20:30:13.000-04:00
Add a README.md to each lib/* sublibrary following the canonical
OrdinaryDiffEq.jl monorepo component template: the Zulip + Global Docs
badge block, the ColPrac + SciML Code Style badges, the
"component of the BoundaryValueDiffEq.jl monorepo" wording, and a
Solvers list of the exported algorithms for each package.

Co-Authored-By: Chris Rackauckas &lt;accounts@chrisrackauckas.com&gt;
Co-Authored-By: Claude Opus 4.8 (1M context) &lt;noreply@anthropic.com&gt;
diff --git a/lib/BoundaryValueDiffEqAscher/README.md b/lib/BoundaryValueDiffEqAscher/README.md
@@ -0,0 +1,22 @@
+# BoundaryValueDiffEqAscher.jl
+
+[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
+[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/BoundaryValueDiffEq/stable/)
+
+[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
+[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
+
+BoundaryValueDiffEqAscher.jl is a component of the [BoundaryValueDiffEq.jl](https://github.com/SciML/BoundaryValueDiffEq.jl) monorepo. It provides the Ascher collocation methods for solving boundary value problems, including problems with algebraic constraints.
+While completely independent and usable on its own, users wanting the full BVP solver suite should use [BoundaryValueDiffEq.jl](https://github.com/SciML/BoundaryValueDiffEq.jl).
+
+## Solvers
+
+- `Ascher1`
+- `Ascher2`
+- `Ascher3`
+- `Ascher4`
+- `Ascher5`
+- `Ascher6`
+- `Ascher7`
+
+For a full description of the solvers and their options, see the [BVP solver documentation](https://docs.sciml.ai/BoundaryValueDiffEq/stable/).
diff --git a/lib/BoundaryValueDiffEqCore/README.md b/lib/BoundaryValueDiffEqCore/README.md
@@ -0,0 +1,10 @@
+# BoundaryValueDiffEqCore.jl
+
+[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
+[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/BoundaryValueDiffEq/stable/)
+
+[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
+[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
+
+BoundaryValueDiffEqCore.jl is a component of the [BoundaryValueDiffEq.jl](https://github.com/SciML/BoundaryValueDiffEq.jl) monorepo. It provides the shared core infrastructure used by the boundary value problem solver sublibraries, including common types, the collocation/jacobian machinery, and the solver-independent utilities.
+While completely independent and usable on its own, users wanting the full BVP solver suite should use [BoundaryValueDiffEq.jl](https://github.com/SciML/BoundaryValueDiffEq.jl).
diff --git a/lib/BoundaryValueDiffEqFIRK/README.md b/lib/BoundaryValueDiffEqFIRK/README.md
@@ -0,0 +1,32 @@
+# BoundaryValueDiffEqFIRK.jl
+
+[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
+[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/BoundaryValueDiffEq/stable/)
+
+[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
+[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
+
+BoundaryValueDiffEqFIRK.jl is a component of the [BoundaryValueDiffEq.jl](https://github.com/SciML/BoundaryValueDiffEq.jl) monorepo. It provides the fully implicit Runge-Kutta (FIRK) collocation methods, including the Radau IIA and Lobatto III families, for solving boundary value problems.
+While completely independent and usable on its own, users wanting the full BVP solver suite should use [BoundaryValueDiffEq.jl](https://github.com/SciML/BoundaryValueDiffEq.jl).
+
+## Solvers
+
+- `RadauIIa1`
+- `RadauIIa2`
+- `RadauIIa3`
+- `RadauIIa5`
+- `RadauIIa7`
+- `LobattoIIIa2`
+- `LobattoIIIa3`
+- `LobattoIIIa4`
+- `LobattoIIIa5`
+- `LobattoIIIb2`
+- `LobattoIIIb3`
+- `LobattoIIIb4`
+- `LobattoIIIb5`
+- `LobattoIIIc2`
+- `LobattoIIIc3`
+- `LobattoIIIc4`
+- `LobattoIIIc5`
+
+For a full description of the solvers and their options, see the [BVP solver documentation](https://docs.sciml.ai/BoundaryValueDiffEq/stable/).
diff --git a/lib/BoundaryValueDiffEqMIRK/README.md b/lib/BoundaryValueDiffEqMIRK/README.md
@@ -0,0 +1,21 @@
+# BoundaryValueDiffEqMIRK.jl
+
+[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
+[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/BoundaryValueDiffEq/stable/)
+
+[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
+[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
+
+BoundaryValueDiffEqMIRK.jl is a component of the [BoundaryValueDiffEq.jl](https://github.com/SciML/BoundaryValueDiffEq.jl) monorepo. It provides the Monotonic Implicit Runge-Kutta (MIRK) collocation methods for solving boundary value problems.
+While completely independent and usable on its own, users wanting the full BVP solver suite should use [BoundaryValueDiffEq.jl](https://github.com/SciML/BoundaryValueDiffEq.jl).
+
+## Solvers
+
+- `MIRK2`
+- `MIRK3`
+- `MIRK4`
+- `MIRK5`
+- `MIRK6`
+- `MIRK6I`
+
+For a full description of the solvers and their options, see the [BVP solver documentation](https://docs.sciml.ai/BoundaryValueDiffEq/stable/).
diff --git a/lib/BoundaryValueDiffEqMIRKN/README.md b/lib/BoundaryValueDiffEqMIRKN/README.md
@@ -0,0 +1,17 @@
+# BoundaryValueDiffEqMIRKN.jl
+
+[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
+[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/BoundaryValueDiffEq/stable/)
+
+[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
+[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
+
+BoundaryValueDiffEqMIRKN.jl is a component of the [BoundaryValueDiffEq.jl](https://github.com/SciML/BoundaryValueDiffEq.jl) monorepo. It provides the Monotonic Implicit Runge-Kutta-Nyström (MIRKN) collocation methods for solving second-order boundary value problems.
+While completely independent and usable on its own, users wanting the full BVP solver suite should use [BoundaryValueDiffEq.jl](https://github.com/SciML/BoundaryValueDiffEq.jl).
+
+## Solvers
+
+- `MIRKN4`
+- `MIRKN6`
+
+For a full description of the solvers and their options, see the [BVP solver documentation](https://docs.sciml.ai/BoundaryValueDiffEq/stable/).
diff --git a/lib/BoundaryValueDiffEqShooting/README.md b/lib/BoundaryValueDiffEqShooting/README.md
@@ -0,0 +1,17 @@
+# BoundaryValueDiffEqShooting.jl
+
+[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
+[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/BoundaryValueDiffEq/stable/)
+
+[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
+[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
+
+BoundaryValueDiffEqShooting.jl is a component of the [BoundaryValueDiffEq.jl](https://github.com/SciML/BoundaryValueDiffEq.jl) monorepo. It provides the single and multiple shooting methods for solving boundary value problems by reduction to initial value problems.
+While completely independent and usable on its own, users wanting the full BVP solver suite should use [BoundaryValueDiffEq.jl](https://github.com/SciML/BoundaryValueDiffEq.jl).
+
+## Solvers
+
+- `Shooting`
+- `MultipleShooting`
+
+For a full description of the solvers and their options, see the [BVP solver documentation](https://docs.sciml.ai/BoundaryValueDiffEq/stable/).
