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.

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

Reorganized docs structure #1838

Merged
merged 4 commits into from
Jul 9, 2021
Merged

Reorganized docs structure #1838

merged 4 commits into from
Jul 9, 2021

Conversation

tomchor
Copy link
Collaborator

@tomchor tomchor commented Jul 8, 2021

This is an attempt to make the left menu of the docs feel a bit more intuitive and organized. What I did:

  • Moved benchmarks, function index and library to appendix. I think not many people need that information, so it makes sense put it there I think)
  • Moved appendix to be the last item on the menu (as is customary for most documents)
  • Moved gallery to after the contributor's guide (since I think contributor's guide is more important so it can come first)

I know this is unprompted (nobody complained about the docs) but I think it's a positive change. Eager to hear opinions.

@glwagner
Copy link
Member

glwagner commented Jul 9, 2021

Those changes seem positive to me! I can't find the preview though, any idea where that might be?

@tomchor
Copy link
Collaborator Author

tomchor commented Jul 9, 2021

No idea! According to @navidcy it should be at https://clima.github.io/OceananigansDocumentation/previews/PR1838, but it says page not found.

@tomchor
Copy link
Collaborator Author

tomchor commented Jul 9, 2021

Also here's a more proper source for that: JuliaDocs/Documenter.jl#1131 (comment)

So idk what's wrong here. @navidcy any idea?

@navidcy
Copy link
Collaborator

navidcy commented Jul 9, 2021

Also here's a more proper source for that: JuliaDocs/Documenter.jl#1131 (comment)

So idk what's wrong here. @navidcy any idea?

Strange...
From looking at the log, it seems it didn't push the preview...
https://buildkite.com/clima/oceananigans/builds/3216#7afaa702-7973-4f52-8d71-73e07874666d

Let me look into it bit more :)

@navidcy navidcy added the documentation 📜 The sacred scrolls label Jul 9, 2021
(in truth, just trying out to see if preview is pushed this time)
This reverts commit b51e538.
Copy link
Collaborator

@navidcy navidcy left a comment

Choose a reason for hiding this comment

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

Approve 👍🏼; just good to see the preview that all renders OK before merging.

@navidcy
Copy link
Collaborator

navidcy commented Jul 9, 2021

Now we have a preview: https://clima.github.io/OceananigansDocumentation/previews/PR1838/

(I don't know why... I didn't really do anything...)

@navidcy
Copy link
Collaborator

navidcy commented Jul 9, 2021

Looks good to me

@francispoulin
Copy link
Collaborator

francispoulin commented Jul 9, 2021 via email

@tomchor
Copy link
Collaborator Author

tomchor commented Jul 9, 2021

Now we have a preview: https://clima.github.io/OceananigansDocumentation/previews/PR1838/

(I don't know why... I didn't really do anything...)

Weird... Documenter.jl works in mysterious ways

@tomchor tomchor merged commit f8a2b8f into master Jul 9, 2021
@tomchor tomchor deleted the tc/reorganize-docs branch July 9, 2021 03:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📜 The sacred scrolls
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants