Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove unnecessary doc bits after unification #169

Merged
merged 5 commits into from
Aug 15, 2022
Merged

Remove unnecessary doc bits after unification #169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d2b6f17
Make unified docs more similar
ArnoStrouwen Aug 1, 2022
1e92de5
more unification
ArnoStrouwen Aug 1, 2022
4274dd2
Add installation and contributing bits again
ArnoStrouwen Aug 1, 2022
d204976
update zulip community forum
ArnoStrouwen Aug 2, 2022
f4256e5
finish doc unification
ArnoStrouwen Aug 15, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions docs/pages.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Put in a separate page so it can be used by SciMLDocs.jl

pages = [
"Home" => "index.md",
Comment on lines -3 to -4
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

pages = ["index.md",
"Tutorials" => Any["tutorials/linear.md"
"tutorials/caching_interface.md"],
"Basics" => Any["basics/LinearProblem.md",
Expand Down
15 changes: 9 additions & 6 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,19 @@ Pkg.add("LinearSolve")

- 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](https://discourse.julialang.org)
- 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

Wrappers for every linear solver in the Julia language is on the roadmap. If
there are any important ones that are missing that you would like to see added,
please open an issue. The current algorithms should support automatic differentiation.
Pre-defined preconditioners would be a welcome addition.
Pre-defined preconditioners would be a welcome addition.