Redesign the template #1339
Redesign the template #1339
Conversation
|
Seems we need to exclude the docs folder from linting. Ref the failing build https://travis-ci.org/sinonjs/sinon/jobs/212364765 Would you mind, @afnizarnur? |
|
Already done :) @fatso83 |
|
Took a while before I could Also a big-up for taking the extra time to make sure the site is more readable on mobile. I will hold off merging until another one on the core team signs this one off. What do you think, @sinonjs/sinon-core - should we starte the new week with this design? |
|
This is looking pretty good! I do think that the content area should be wide enough to accommodate 80 chars of code in the examples, without horizontal scrolling.
I think in the case like this, visitors are most likely to be using desktop browsers with desktop screens. What do you think? |
| <div class="footer-col footer-col-1"> | ||
| <ul class="contact-list"> | ||
| <li>{{ site.title }}</li> | ||
| <li><a href="http://groups.google.com/group/sinonjs">http://groups.google.com/group/sinonjs</a></li> |
There was a problem hiding this comment.
Are we sure we want to get rid of this? I think we should have at least the same pointers as we already have in the README on Github. If not in the same place, then somewhere.
There was a problem hiding this comment.
The link is on the homepage at the very bottom now. However, I think having the Google group to the footer on all pages (additionally) is a good idea.
There was a problem hiding this comment.
Yeah, I forget to add the google group 😅 . Will proceed it now, and add it to the footer.
| {% include header.html %} | ||
|
|
||
| <div class="content"> | ||
| <div class="container container-2"> |
There was a problem hiding this comment.
This might be a bit of a nitpick, but container-2 does not tell me much in the way of "what separates this from the normal container". Might choose a slightly more telling name?
There was a problem hiding this comment.
I agree with you. Basically, it's just different container size.
| @@ -1,10 +1,10 @@ | |||
| --- | |||
| layout: page | |||
| title: API documentation | |||
| title: Sinon.JS - API documentation | |||
There was a problem hiding this comment.
Good, this is a lot better for SEO.
There was a problem hiding this comment.
Yeah, may I change all of the title pages to the better title? I found many titles in documentation is not using good SEO
|
I also find that we should be able to see a width of 80 chars in code snippets on desktop. Scrolling is fine if on mobile. |
|
Looks great! I agree that the font size of the code snippets could be a little smaller to fit 80 characters. I'd vote to merge and deploy this with the one font-size change – or maybe even as is – and iterate on it from there. It's already a big step forward. Thank you @afnizarnur for the nice work! 👏 👍 |
|
Yeah, I agree on the "merge and iterate until perfect" approach. Merge at will :-) |
|
Aaaaaaand the new design has shipped! http://sinonjs.org However, the GitHub asset is missing, which was not the case when I checked locally. Any idea why @afnizarnur ? |
|
No worries, got it. GitHub hosting is apparently case sensitive while the locally served version is not. |
|
Wow cool thanks! Glad to help Sinon.JS 😃 🙌 🎉🎉🎉🎉 @mantoni |
* Redesign the template * Fix error * Exclude docs/assets/ from .eslint
Redesign the documentation based on #1304