search

stylus / nib

Stylus mixins, utilities, components, and gradient image generation
http://stylus.github.io/nib
MIT License
1.9k stars 250 forks source link

New site (redesign, updated documentation, and more) #269

Closed incompl closed 3 years ago

incompl commented 10 years ago

This PR is the same as #267 but this one uses the gh-pages branch instead of a directory in master. If one is merged, the other should be closed.

notslang commented 10 years ago

Maybe documentation should just link to https://github.com/visionmedia/nib/tree/master/docs so we don't need to update the site every time the docs change. Anyone else have thoughts on this?

incompl commented 10 years ago

I think the website should be the docs. It's in github so it's easy to update; there is no updating the site every time the docs change. The github page you linked to is markdown generated from the site. However, it lacks the extra usability features that I built for the site. It seems like a huge waste to build a great site, then generate markdown from it, then throw out the site.

On Mon, Jul 21, 2014 at 11:02 AM, Sean Lang notifications@github.com wrote:

Maybe documentation should just link to https://github.com/visionmedia/nib/tree/master/docs so we don't need to update the site every time the docs change. Anyone else have thoughts on this?

— Reply to this email directly or view it on GitHub https://github.com/visionmedia/nib/pull/269#issuecomment-49616946.

notslang commented 10 years ago

True, but when someone makes a PR to roots, I can ask them to include the changes to the docs directly in the PR. Having them coordinate a 2nd PR into gh-pages at the same time is much more difficult.

Maybe we could make some way of automatically pulling the docs from https://github.com/visionmedia/nib/tree/master/docs into the site? I was able to do basically that for https://github.com/slang800/jade-book.

incompl commented 10 years ago

The site is already in a separate branch, so the 2-PR problem is not new. The concern of adding improved tooling should not stand in the way of launching the awesome new site that is ready for nib users to benefit from today.

On Mon, Jul 21, 2014 at 11:16 AM, Sean Lang notifications@github.com wrote:

True, but when someone makes a PR to roots, I can ask them to include the changes to the docs directly in the PR. Having them coordinate a 2nd PR into gh-pages at the same time is much more difficult.

Maybe we could make some way of automatically pulling the docs from https://github.com/visionmedia/nib/tree/master/docs into the site? I was able to do basically that for https://github.com/slang800/jade-book.

— Reply to this email directly or view it on GitHub https://github.com/visionmedia/nib/pull/269#issuecomment-49618944.

incompl commented 10 years ago

Would love to see this merged, any thoughts on this?

incompl commented 10 years ago

Any thoughts?

incompl commented 10 years ago

Anyone there?

jamesplease commented 10 years ago

I'd love to see this merged, too.

@slang800, reading documentation on Github is good for some smaller projects, but I think nib has crossed the threshold of size where having a dedicated website will be hugely beneficial to users trying to reference features of the library.

The extra functionality you described is something that can be added at a later date, I think. It's clear from this PR that there are members of the community who care about the project and are willing to help make it better!

:+1: on merging this~

jamesplease commented 10 years ago

One more thing: it's not like nib has been all that active lately, anyway, so a brief period of time where the documentation on the site isn't automatically updated won't cause anyone an inordinate amount of trouble, anyway. The tremendous benefits to the users of the library are worth it, I think.

What do you think, @slang800?