Closed danilovaz closed 8 years ago
@gulpjs @sindresorhus @contra
cool!
Lots of grammar and formatting fixes needed
Thanks @phated I will fix this text.
@contra Sorry, my English is not the best. Then I'll need a little help in this. If possible, could show me what needs to be fix? Thanks, I appreciate if this pull request comes to add to the project.
@danilovaz Yeah I will take a look through it when i have some time.
@heikki Got a minute to help?
Okay @contra , thank you.
@contra traveling right now, can take a look in a day or two.
Hmm.. a week or two would've been more accurate. First things:
--edit just noticed the original style was inconsistent
these people use gulp, please.
n/m, just saw @phated's comment, ignore me.
Not sure I like the arrow being split between the header and content - it should be much smaller and solely within the header
Looks like this PR is broken with the latest dependencies. Although it's a great inspiration for the next major improvement on this site, I don't think it's a great idea to resolve the conflicts and merge it. Not only because it's broken now, but also because I think that the PR would need a big revamp in terms of design and structure.
Since some other people complained about the current state of the site, too, I will probably add a better explanation of what Gulp actually is and a short quick start guide to the it (like this PR has it) in the next few weeks.
@danilovaz Thank you for your hard work!
If someone of the participants thinks differently about this, feel free to re-open it.
@leo just to let you know, we are planning on switching to readme.io soon (http://gulp.readme.io) for documentation
@contra Just for documentation? Or will the homepage completely be replaced?
@leo Not sure yet, what do you think? The readme.io homepage can include custom HTML/CSS/JS if we want to
@contra I honestly wouldn't use it at all. I mean, it's definitely an interesting tool since it allows developers to easily edit their stuff without making changes to real code. But all in all, I still think @jekyll running on GitHub Pages would be a better fit. Here are few reasons:
.md
file and you're done. Within it, you can then write in the same format as on Readme.io: Markdown._posts
folder, put all of them in there and create a single page which shows them all).@leo Features that made readme.io appealing: search, documentation versioning, discoverability
If we can make our own thing that accomplishes the same features and looks just as good then I'm all for it.
:-1: on jekyll. Setup is miserable. I've struggled with it a ton in the past.
@contra
Just look around the web, there are many big open source projects which are using Jekyll for documentation and their landing page.
@phated Examples? I mean, while creating a lot of static sites with it, I haven't yet had any major problems with it. Also, Jekyll is Open Source, so if there's something that can be fixed, you know what to do: Just let them know... :blush:
@leo If you want to take a whack at implementing it I'd love to see an example of a design/layout you see being maintainable
@contra Sorry for the late answer, but I'm currently working on a huge project (which isn't public yet). While I'd love to help you with the development, I'm not sure if it's such a good for me to make huge efforts without even knowing if you'll be alright with Jekyll... :innocent:
Nevertheless, here are some of my thoughts on this: I would keep the main page as it currently is and maybe include a few more infos about what Gulp actually is. And then, after clicking on "Docs", the user will see an overview page which looks very similar to this (header on top which includes the most important links and a menu on the left which includes a few links to dive deeper into the docs).
Added an animated text in the header and a button for scroll to content. I separated the site of subjects in Sections to improve semantics, added 2 Sections: "How to use Gulp" and "This guys use Gulp". Also added a footer.
Preview: