Skip to content

Conversation

@sbesson
Copy link
Member

@sbesson sbesson commented Nov 23, 2012

Sidebar changes similar to those in ome/bioformats#236:

  • fix breadcrumbs/Sphinx navigation duplication
  • add customized global TOC with links to downloads, licensing and feature list pages

@will-moore
Copy link
Member

Side-bar / Prev/Next links:

  • The overall problem I have with the current navigation is that there's no 'site map'. There's not way for me to browse the entire content of the BF documentation to make sure I haven't missed something I'm interested in. One thing that the Prev / Next buttons give you is some way to navigate EVERY page (although very slowly - 1 at a time).
  • Either the front page needs a complete TOC tree or the top level pages need one each (like the User Information page).
  • I don't think that the Prev / Next buttons do any harm, and if you've come from the OMERO docs and found them useful there, then you definately miss them. Curtis says they seem "rather useless" and "seems very strange to me to have 'next' and 'previous' links without also having a link to a master hierarchical TOC". But I don't think this means we have to abolish them completely.

Breadcrumbs:

@hflynn
Copy link
Contributor

hflynn commented Nov 23, 2012

The Docs home page does link to OMERO and BF Docs home pages but it's the bottom 'other info' links on each section. I could move this to be the first link if you think that would be clearer.

@will-moore
Copy link
Member

@hflynn Yes - that would help a lot. I completely didn't them it as it is now.
Ideally I'd like the home-page links at a 'higher level' than the sub-links (not just first in the list), but I'll leave you to decide what works best. Cheers.

@hflynn
Copy link
Contributor

hflynn commented Nov 23, 2012

Docs home web page fixed.

Suggest we remove the commit 'Remove duplicate navigation bar' and just go with the other one, looking to turn off the plone breadcrumb at some point instead.

@sbesson Can you put the sphinx top navigation bar/breadcrumb back into BF as well, please?

@sbesson
Copy link
Member Author

sbesson commented Nov 23, 2012

@will-moore , @hflynn : replaced the plone breadcrumbs by the Sphinx navigation bar

@will-moore
Copy link
Member

Looks great! Sphinx breadcrumbs work nicely, the Documentation homepage is nicely organised now. Good to merge (in my opinion).

@pwalczysko
Copy link
Member

This page
https://www.openmicroscopy.org/site/support
looks empty on the right and is of different style than the pages under it (fonts, colours, layout).
Is it still under construction ?

This pdf. - the text in title binds to the right - never saw such thing - could we make the text bind to the left or centre it ?
https://www.openmicroscopy.org/site/support/omero4/OMERO-4.4.5.pdf

(not sure if it belongs to this PR here, but where then ?) Some screenshots here
http://www.openmicroscopy.org/site/products/omero/screenshots/ I do not know at all, mainly:
This screenshot is outdated ?http://www.openmicroscopy.org/site/products/omero/screenshots/images/30-image-region-manager-mac.png/image
This screenshot is outdated ? as well
http://www.openmicroscopy.org/site/products/omero/screenshots/images/30-importer-chooser-ubuntu-mac-win.png/image
Is it the 4.5 version ? (but it is not present on Gretzky either - maybe it IS outdated)

@hflynn
Copy link
Contributor

hflynn commented Nov 27, 2012

@pwalczysko The top page looks different because it's a plone page not in the sphinx docs - it is just to replace the default indexing page.

As for the rest, not for this PR but there is a ticket here:
https://trac.openmicroscopy.org.uk/ome/ticket/9312

for reviewing screenshots so I suggest you paste this comment over there.

@joshmoore
Copy link
Member

  • Crumbs: good
  • Italics: good
  • Sidebar: good

Merging.

joshmoore added a commit that referenced this pull request Nov 28, 2012
Improve documentation sidebar
@joshmoore joshmoore merged commit 09a6ff0 into ome:dev_4_4 Nov 28, 2012
This was referenced Nov 28, 2012
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants