Initial docs restyling #2612
Initial docs restyling #2612
Conversation
Enable: logo, smart quotation marks Disable: links to reST sources
There was a problem hiding this comment.
Thanks @medubelko ! Looks great. I haven't tried on mobile, but I believe you on those bits. Just a couple small comments/questions.
doc/source/_static/GafferLogo.svg
Outdated
| @@ -0,0 +1,146 @@ | |||
| <?xml version="1.0" encoding="UTF-8" standalone="no"?> | |||
There was a problem hiding this comment.
Rather than adding the logos directly, can we just copy them in-place using a generate script? They're already in the repo under <localClone>/resources/, so we should be able to copy them during the doc build itself.
There was a problem hiding this comment.
I wasn't sure if there was ever going to be a point where they might differ, so for now I just made them static. If you think it's unlikely, should it be added to SCons or its own generate.py script?
There was a problem hiding this comment.
I'd say its own generate.sh script (simple cp command). If you want to add that now, I can rebase my other branch top of this and adjust it to the new style generate for you.
|
|
||
| /* Add icon after external links */ | ||
| a[href^="http"]:after { | ||
| content: " " url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAYAAACNMs+9AAAAVklEQVR4Xn3PgQkAMQhDUXfqTu7kTtkpd5RA8AInfArtQ2iRXFWT2QedAfttj2FsPIOE1eCOlEuoWWjgzYaB/IkeGOrxXhqB+uA9Bfcm0lAZuh+YIeAD+cAqSz4kCMUAAAAASUVORK5CYII=); |
There was a problem hiding this comment.
I'm not sure how I feel about this one. None of the websites we're linking to use an icon for their links... is this considered standard?
There was a problem hiding this comment.
It adds the standard external link icon (
There was a problem hiding this comment.
Yeah, I know. I'm just saying its a courtesy that none of the links on our main page (Arnold, Appleseed, 3delight, Tractor, Sphinx) are doing themselves for their external links, so I was wondering if that's modern standard UX or legacy from wikipedia days?
There was a problem hiding this comment.
This will differ from the main site. They're still relevant and useful for most help files and docs.
Websites don't use them very often, because there's an understanding by the user that on the web (= multiple "documents," dynamic) most body text links are external references. In docs it's the opposite: most body text links are to other pages in the same help system (= single "document," static), and suddenly opening an external link can be jarring and disruptive. A more immediate use for this is that it will signal to IE users that they'll need to open that link in Isla.
A more complex way of accomplishing this is to use automatic hover-text, but this was the simpler and more direct method.
There was a problem hiding this comment.
Ok, fair enough. Thanks for the explanation.
- Add Gaffer branding and colors to nav and search - Minor adjustments to headers and links - Adjust mobile header title and menu button
|
Added generate.sh to drag in the logo files, as discussed. |
|
Thanks! |
Initial docs restyling to better match Gaffer colors and branding.
Changes