SciML / LinearSolve.jl

LinearSolve.jl: High-Performance Unified Interface for Linear Solvers in Julia. Easily switch between factorization and Krylov methods, add preconditioners, and all in one interface.
https://docs.sciml.ai/LinearSolve/stable/
Other
248 stars 53 forks source link

prototype canonify docs #208

Closed ArnoStrouwen closed 2 years ago

ArnoStrouwen commented 2 years ago

Contains 3/4 points of https://github.com/SciML/SciMLDocs/issues/53 .

I have only updated links between different sciml.ai documentation, but there are also quite a few github links. Should a link to e.g. catalyst github just link to to catalyst docs?

I think the within package links are smart enough by themselves, e.g. https://docs.sciml.ai/ModelingToolkit/stable/tutorials/ode_modeling/#Notes-and-pointers-how-to-go-on

codecov[bot] commented 2 years ago

Codecov Report

Merging #208 (c321f4f) into main (8550cf9) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #208   +/-   ##
=======================================
  Coverage   64.00%   64.00%           
=======================================
  Files           9        9           
  Lines         625      625           
=======================================
  Hits          400      400           
  Misses        225      225           

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

ChrisRackauckas commented 2 years ago

I think the within package links are smart enough by themselves, e.g. https://docs.sciml.ai/ModelingToolkit/stable/tutorials/ode_modeling/#Notes-and-pointers-how-to-go-on

Yes, they will @ref and use local links. It's just the links between packages, and any that were not properly using @ref.

Should a link to e.g. catalyst github just link to to catalyst docs?

Yes for sure. I think we should consider the Github for "the hardcore" who want to see the source code and interact with the issues. For most people, Github isn't a friendly introduction to a package!

ChrisRackauckas commented 2 years ago

I think this looks great!