-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Redesign coffeescript.org? #4370
Comments
That all sounds perfect. |
Some inspiration: https://github.com/PharkMillups/beautiful-docs |
I'd love to work on this… I wonder if it would be worth splitting coffeescript.org into it's own repo and moving to a CoffeeScript oraganisation? |
Nope! Changes to the docs are often made in sync with new features being added to the compiler. |
What would be screwed up by moving the main repo into the |
Nothing at all. |
What about a refresh of the logo/script font to reflect the new modern changes? |
Actually i'm working on smth. related. |
@Asc2011 The v1 and v2 docs will be separate pages/sites. Our goal is just to teach people how to use CoffeeScript, not how CoffeeScript works; the latter is covered by the wiki of this repo, or sites like https://astexplorer.net. |
@GeoffreyBooth In the spirit of 'interactive code writing' and 'living documents' i believe its a nice idea to have the docs and a panel to test code side-by-side. |
Would like to share some thoughts and html mock-up
So in general what do you think, is that good for start point? debug version here : http://codepen.io/lazypacman/pen/yVoQXY |
I really like the Laravel docs too. Can we make ours look a bit more like theirs? The pink and brown and yellow feels a bit much to me personally. I suppose if we want to go with the “coffee” theme we should be shades of brown, maybe highlight with dark green . . . My big request is that we get a scrollspy sidebar like this. |
Are you looking to have it built with a static site generator - Jekyll, Middleman, etc... - or a specific pre-processor - haml, Sass, Less, jade, etc... - or is basic html / css fine? Additionally, any opinion on libraries such as bootstrap / bourbon, or are we trying to keep it library free as much as possible? |
It's just a single page: https://github.com/jashkenas/coffeescript/blob/master/documentation/index.html There's some preprocessing happening to insert the code blocks, but that's it. I'd prefer not to add a CSS preprocessor into the mix unless our styling gets much more complicated than it is now. Our target browsers for CS2 are evergreen. I was thinking of adding the Bootstrap JS at least, to enable the scrollspy; adding its CSS too would be fine I think. I would load both via CDN. |
@jashkenas @lydell I’ve been working on the foundation for the v2 docs in the I haven’t done any significant styling yet, in the hope that this thread will produce a design we all like. The styles for now are plain Bootstrap 4 and default CodeMirror syntax highlighting. What I’ve been focusing on is implementing a better build process, a scrollspy sidebar, and editable code examples. Try editing any of the CoffeeScript code blocks! The content is still the same from v1, aside from the JavaScript output from the v2 compiler, so that still needs to get updated too. But this page is the skeleton of what the v2 docs will be. Anyone else on this thread, what would you do to this page to make it better? |
@GeoffreyBooth Very nice first draft! I like the sidebar and the editable code examples very much. 👍 |
@GeoffreyBooth The editable code examples are awesome, very nice addition! I hope to have a small demo or two together this weekend and was curious your thoughts on a collapsable sidebar (toggle offscreen by clicking menu button or similar)? I am by no means a designer, but hopefully I can provide something of use, if even only a snippet here and there. I will update in a couple days (Monday the latest) with what I have. Thank you for encouraging contributions. Cheers. |
My thinking was to have a collapsible sidebar on mobile. |
Second draft. This makes the sidebar work on mobile. Sorry if I stole your thunder @tyrollins, I was already working on this. I think I’m going to focus next on the actual content of the sidebar, shortening some of these heading titles and otherwise editing the text. The other big technical thing to figure out is “Try CoffeeScript” (should we call it something else? Online Demo?) which is basically just a fullscreen version of the editable code blocks. What I could really use help on is some vision of how these pieces should look. Fonts, colors, margins, padding, etc. |
A bit of padding to boost (read/scan)ability: p, .code-example {
margin-bottom: 1.3rem;
}
h2 {
padding-top: 2rem;
margin-bottom: 1.3rem;
}
h3 {
padding-top: 1rem;
} |
I feel that the code blocks (and perhaps the menu?) could use a bit of line spacing. .sidebar {
line-height: 2;
}
.CodeMirror {
line-height: 1.25;
} Less trivially, I wonder if there's something more that could be done to evoke the original site? Perhaps we could keep a floating header in a more material design style? Also, I'd love there to be a more prominent link to the GitHub repo. For years whenever I've typed "coffee" into Chrome it only recommends the coffeescript.org address, and the link to the GitHub repo is pretty awkward to get to (Table of Contents -> Resources -> Source Code). |
I've been unable to do much lately (health issues), but just wanted to chip in to say that the old site had a nice look that people associate with CS. Probably best to rip that off as a starting point. Also wanted to say a big thank you. So nice to know Coffee's future is bright. |
Thanks @carlsmith. It was @jashkenas who requested that we move away from the “brushed metal” aesthetic; maybe it can be modernized in some way? @connec take a look at the site on mobile (or in a narrow desktop browser) and you’ll see a header bar. Perhaps that should be present on all sizes? And on the larger breakpoints, it can have a few important links up there. |
Are you keeping this on your personal fork, or pushing to a branch of this repo?
Some thoughts I had…
|
Ah, fair enough. Sorry. Haven't really followed this. I still like that look, but yeah, it's not very modern.
Yeah, a modern, flat, minimal look, with two or three different shades of a nice mocha to add some colour and fun, sounds pretty nice, but I'll leave it to you guys. Too many cooks. All the best. |
Okay, I’ve taken a stab at some colors and fonts and updated spacing. I’ve also started reworking the header and sidebar, which I hope should be working now on desktop, tablet portrait and mobile. I’ve also started rewriting the text. There’s now a section explaining what CoffeeScript 2 is (what else should I say or not say?) and I’ve removed several paragraphs of outdated info. I was surprised to notice that some very basic parts of the language never had proper explanation—we have a section on block strings and block comments, but there’s no section on simple strings or comments. I’ve added those, please let me know what you think. I put them in as isolated commits, so that we can backport these additions to the v1 docs if people want. Still to do:
Pull requests against my |
I think it looks really good, nice work! |
Lovely stuff, @GeoffreyBooth — it's coming along great! I might find time to muck around in your branch a little bit in the next few weeks. But my only real constructive criticism right now that might be easy to tweak ... is to echo @connec and @carlsmith's comments from above. The new layout is lovely, but it could be nice to maintain a little visual consistency from the old site, to make it feel like home: just a bit of color scheme, and maybe a very faint ribbed background on part of the page could do the trick. No brushed metal required. |
Okay, I’ve added some ribbing. If anyone has more specific ideas about how to evoke the old site, please suggest some code 😄 Any thoughts about CodeMirror and syntax highlighting? |
Only thought is that — I think getting a pull request in to Codemirror / upgrading their syntax highlighting is the way to go. |
Okay, I’ve added Try CoffeeScript, including its “play” and “link” buttons. Still to do (pull requests welcome!):
|
Having a section about upgrading from 1.x in the 2.0 docs makes sense to me. |
Wow! Great work so far Geoffrey Booth! My only real comment is that the transition from the examples to the CoffeeScript 2 section was that it left me wondering "What is CoffeeScript 1? Do I need that? What's the difference?" I tried it from my Samsung Galaxy, and it formatted quite nicely. I did run into an issue where the back button ruined the formatting. Other than that everything looks amazing! Very excited to see all of this coming together! |
Good job @GeoffreyBooth!
Otherwise, I quickly designed my own interpretation (if you want to go with that and need code contributions, let me know): |
@ArthurWhite sure, do you want to submit a pull request? You could show everyone your version via rawgit.com like I have. Please make sure it works on mobile and tablet. That was the reason I added the top bar, though it could perhaps only be visible on tablet portrait and down. The light stripes are definitely retro, but they were a request from the crowd (see above on this thread). I would say go ahead and replace them, but don’t be surprised if people ask for them back 😄 |
I don't have an HTML version for now, only this preview made in Sketch. 👨🎨 (The responsiveness should not be a big deal, even without a top bar.) |
I’ve merged the CS2 docs as they are so far into the At this point, I think further revisions (or redesigns) should take what’s on |
@GeoffreyBooth great job! Is there a particular deadline that you have on the docs design, or is it just the sooner the better? I'm not aware of the time frame for CS2 completion, so not sure how to gauge it... But I'm eager to contribute. |
@tyrollins I’m eager to get the first alpha released whenever #4424 is finished, which hopefully isn’t too far away. You can see our progress at https://github.com/coffeescript6/discuss#coffeescript-2. The alpha can always launch with the docs as they appear now and we can revise them. |
No point in keeping this issue open, though that’s not to say we’re uninterested in improvements to the website, or even further redesign. Feel free to continue to post mock-ups for feedback, but at this point if you want to see your mock-up realized you need to do the coding yourself and submit a pull request with your new design. Thanks! |
Flattery:
– @egoist via https://twitter.com/_egoistlily/status/1261673949097627648?s=20 |
@GeoffreyBooth I was waiting for someone to point this out, thank you. Will add a link on the website to address the inspiration. |
Migrating from coffeescript6/discuss#53
Version 2.0.0-alpha1 of CoffeeScript is coming soon, and we’d like to modernize the design of coffeescript.org for the v2 docs. Any designers out there who would like to help with this?
General criteria:
Update: The work-in-progress CS2 docs have been merged into
2
branch, and can be viewed here: https://rawgit.com/jashkenas/coffeescript/2/docs/v2/Please take this as your starting point, and submit pull requests against
2
based on this code. Note that you should only be editing files indocumentation
; thedocs
folder is for generated output only (similar to howsrc
compiles intolib
).The text was updated successfully, but these errors were encountered: