Redesign the NIB homepage

[simonwjackson]

I'd like to contribute to the project by updating the NIB homepage/documentation. It could use a little bit of flare and it would be nice if it was a bit more more responsive/accessible.

Is the design under source control by chance?

Let me know if I can contribute. My design portfolio is at: http://www.behance.net/simonwjackson

[tj]

sounds great :) it was just a really quick hack

[notslang]

The homepage design is in the gh-pages branch... though having it in a branch doesn't really make much sense because it's not directly related to the nib code. It should really be in a separate repo so documentation issues don't get mixed in with code issues.

And of course you can contribute! That's what github is all about :) ... just fork it and make it better. When you're done, PR it back in.

PS: Nice portfolio, I'd love to see what you can do with that doc site.

[skw]

It does make sense that it's in the gh-pages branch, as far as github is concerned.

[notslang]

yeah, but github isn't concerned quite far enough... branches are supposed to hold alternative versions of the code for stuff like new features, or experiments... not completely different projects. anyway, i'm prolly ranting in the wrong place, but that's what I'm talking about.

[skw]

Haha well it's a discussion that needs to be had. The argument for keeping it in the gh-pages branch would be that it retains a url that reflects the url of the github repo.

Also many projects utilize tools (like docco) for generating docs which draws upon the actual source when generating documents.

I think your rant is valid in this case but it either getting a domain for nib or perhaps mixing some document generation into the site.

[incompl]

I'm taking a crack at this and hoping to have something to show this week

[incompl]

I did some work today that is here https://github.com/incompl/nib/tree/new-site

• Responsive design
• Separate documentation page with index
• Uses stylus and nib now 🐱

I want to work on the design / logo a bit. I also want to make sure everything is documented.

If anyone wants to make a list of undocumented features that'd be really useful! Otherwise I will dig around myself a bit.

[notslang]

Oh, btw: you might want to look at using roots for building the site. We made it here at Carrot for compiling languages like stylus/jade/coffee into static sites. Also, it has full support for nib

[incompl]

This is what I put together, what do you think?

http://nibstyl.us/

[incompl]

I still want to dig through the source and figure out what might be undocumented and add that, but was still hoping someone might be able to provide a list of undocumented features if there are any.

[notslang]

I like the domain name choice - it's a bit nonsemantic since TJ is from Canada, but the resulting name is too cool to pass up.

The design is looks nice, but it would be a bit more clear if the "stylus+nib" and "resulting css" boxes were side-by-side (rather than on top of each other with the word "yields:" in between). Also, a table of contents on the left side of the screen would be really nice, kinda like we did here: http://roots.cx/axis/.

The docs need some work to cover all the features that nib has, but that's gonna require some digging in the source code

[incompl]

Great, I'll do that stuff this week as I have time. Thanks!

-Greg

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

I like the domain name choice - it's a bit nonsemantic since TJ is from
Canada, but the resulting name is too cool to pass up.

The design is looks nice, but it would be a bit more clear if the
"stylus+nib" and "resulting css" boxes were side-by-side (rather than on
top of each other with the word "yields:" in between). Also, a table of
contents on the left side of the screen would be really nice, kinda like we
did here: http://roots.cx/axis/.

The docs need some work to cover all the features that nib has, but that's
gonna require some digging in the source code

—
Reply to this email directly or view it on GitHub
#186 (comment).

[incompl]

Today I added the following:

• Code source/compiled widget
• Sticky documentation sidebar
• Nicer URLs

I tried the side-by-side method for the code but it was just too wide. I
hope you like the embed-like tabbed widget approach that I used instead.

All changes visible here: http://nibstyl.us/

On Mon, Jun 16, 2014 at 11:59 AM, Greg Smith greg@bocoup.com wrote:

Great, I'll do that stuff this week as I have time. Thanks!

-Greg

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

I like the domain name choice - it's a bit nonsemantic since TJ is from
Canada, but the resulting name is too cool to pass up.

The design is looks nice, but it would be a bit more clear if the
"stylus+nib" and "resulting css" boxes were side-by-side (rather than on
top of each other with the word "yields:" in between). Also, a table of
contents on the left side of the screen would be really nice, kinda like we
did here: http://roots.cx/axis/.

The docs need some work to cover all the features that nib has, but
that's gonna require some digging in the source code

—
Reply to this email directly or view it on GitHub
#186 (comment).

[notslang]

Now that I think about it, we really need the docs to be a part of the main repo - like something that I can ask people to include in their PRs... I feel like that would prevent the docs from getting horribly out of date again.

We should look at some way of having the content of the site exist in this repo (probably as Markdown), and then compiling it into the site at nibstyl.us. Maybe like RTFD does?

[incompl]

I'll send a PR for this soon. I personally prefer a directory on master to a docs branch. Sound good?—
Greg

On Wed, Jun 25, 2014 at 10:36 AM, Sean Lang notifications@github.com
wrote:

Now that I think about it, we really need the docs to be a part of the main repo - like something that I can ask people to include in their PRs... I feel like that would prevent the docs from getting horribly out of date again.

We should look at some way of having the content of the site exist in this repo (probably as Markdown), and then compiling it into the site at nibstyl.us. Maybe like RTFD does?

Reply to this email directly or view it on GitHub:
#186 (comment)