-
Notifications
You must be signed in to change notification settings - Fork 190
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.
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
The start of documentation 2.0 #3673
Conversation
@navidcy I have also enabled push previews for this PR but we can disable before merging. |
We'll be looking here for previews: https://clima.github.io/OceananigansDocumentation/previews/PR3673 |
@navidcy I think it would be cool to show a visualization of the grids in the "Grids tutorial" |
I tried this link but received a 404 error. Does it work for others? |
It errors for me too! Nothing will come up until the docs build passes, looks like it is still failing. |
I think we should improve the docstring for Oceananigans.jl/src/DistributedComputations/distributed_architectures.jl Lines 174 to 205 in 8f55656
A few comments:
In general more explanation of the keyword arguments that is as local to the concept of grids as possible. The docstring makes vague references to "support for partitioning". But this refers to models, not grids. It doesn't really make sense in this context. Also we need examples. |
The distributed doctests in |
@glwagner I removed the "Distributed Grids" part from the docs. I suggest we merge this if Docs built and open a new PR with the distributed grids part of the tutorial? |
This PR reorders the documentation and will add a
Grids
andFields
page to the top-level of the docs. It will also clean up minor outstanding issues.Longer description of our intent: #3672
Closes #3649