Documentation mismatched with code?

thoughtbot / neat

A fluid and flexible grid Sass framework

https://neat.bourbon.io/

MIT License

4.42k stars 424 forks source link

Documentation mismatched with code? #616

Closed sixtyfive closed 7 years ago

sixtyfive commented 7 years ago

Issue Summary

Reading the neat docs, I can't use neat. Wondering if it should be, at this time, best practice to only use Bourbon/Neat/Bitters from their respective Github repositories?

Steps to Reproduce

Read neat docs
Try to use grid-container
Find out it does not exist
Remember something about outer-container
Wonder why that works even though it's not mentioned in the docs

Really going for that shower now.

sixtyfive commented 7 years ago

It seems the documentation is already in sync with the Neat version here on Github.

tysongach commented 7 years ago

The outer-container mixin was removed in 2.0. A new mixin named grid-container is in 2.0 and accomplishes a similar task.

Docs for 2.0 grid-container: http://neat.bourbon.io/docs/latest/#grid-container
Docs for 1.x outer-container: http://neat.bourbon.io/docs/1.9.0/#outer-container

You can always view older documentation on the website via this dropdown:

sixtyfive commented 7 years ago

Tyson, thank you and sorry for being so ignorant (or rather, blind) and not see that dropdown. Anyways, I've made the switch to the git versions now and I'm quite happy for it.