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

More docs unification #79

Merged
merged 3 commits into from
Aug 15, 2022
Merged

More docs unification #79

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
961e622
More docs unification
ArnoStrouwen Aug 2, 2022
dae1aa9
revert doc title
ArnoStrouwen Aug 2, 2022
7243315
title SEO
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
2 changes: 1 addition & 1 deletion docs/pages.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Put in a separate page so it can be used by SciMLDocs.jl

pages = [
"Home" => "index.md",
"Overview" => "index.md",
Copy link
Member

Choose a reason for hiding this comment

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

We do need some kind of tag line.

Screenshot 2022-08-02 094516

Otherwise it won't do well in search. This doesn't necessarily need to be the label in the SciMLDocs.

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't immediately see a way for the two to be separated?
The <title> element of https://nonlinearsolve.sciml.ai/ seems to be "first item on dropdown menu · NonLinearSolve.jl"
where NonLinearSolve.jl is what is used as the sitename keyword argument in the makedocs function.

Copy link
Member

Choose a reason for hiding this comment

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

We can make a bool that is set before pages.jl is loaded that then allowed for is_scimldocs and to switch whether to place the title on or not.

But I would greatly prefer just always having the title so it shows up on search engines, and making an issue to Documenter.jl to decouple the sidebar name from the title.

Copy link
Member Author

Choose a reason for hiding this comment

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

You can give a different sidebar name using that technique, but you still have to fill in something for the sidebar for is_scimldocs=false.

Currently for DifferentialEquations.jl it is

<title>DifferentialEquations.jl: Scientific Machine Learning (SciML) Enabled Simulation and Estimation · DifferentialEquations.jl</title>

Which has DifferentialEquations in there twice, once from the a name in the dropdown menu and once from the sitename keyword argument.

So you could make the sitename argument an empty string. But then if you go to down the dropdown menu e.g

<title>Solving Large Stiff Equations · DifferentialEquations.jl</title>

It would also lose the DifferentialEquations, which is not great if somebody is searching for: "stiff equations DifferentialEquations.jl".

I'll make an issue with Documenter.jl .

"Tutorials" => Any["tutorials/nonlinear.md",
"tutorials/iterator_interface.md"],
"Basics" => Any["basics/NonlinearProblem.md",
Expand Down
13 changes: 8 additions & 5 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down