Remove unnecessary doc bits after unification #169
Conversation
Codecov Report
@@ Coverage Diff @@
## main #169 +/- ##
==========================================
- Coverage 66.87% 60.40% -6.48%
==========================================
Files 9 9
Lines 631 639 +8
==========================================
- Hits 422 386 -36
- Misses 209 253 +44
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Should the basic installation code example be in all package docs? Some packages have a home, others have an overview. I prefer overview. |
|
I think these bits should stay. Every package should have an intro IMO. |
docs/src/index.md
Outdated
| for guidance on PRs, issues, and other matters relating to contributing to ModelingToolkit. | ||
| - 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 |
There was a problem hiding this comment.
can you use the one that I showed? It had the updated Zulip form.
| pages = [ | ||
| "Home" => "index.md", |
There was a problem hiding this comment.
This change makes the sidebar pretty ugly since it will use LinearSolve.jl: High-Performance Unified Linear Solvers (the title on the index.md page) instead of Home. (Compare https://linearsolve.sciml.ai/dev/ with https://linearsolve.sciml.ai/stable/)
There was a problem hiding this comment.
There is currently no way to have the title bar not be ugly while having the <title> element of the page be something snappy for search engine optimization.
JuliaDocs/Documenter.jl#1898
Discussing with Chris, we decided optimizing for SEO and fixing the title bar later.
There was a problem hiding this comment.
Yes. For now I think having the results show up properly in Google is worth more than a cleaner sidebar. When we can unlink the two then it will get updated.
No description provided.