Compass Documentation + Site

6 views
Skip to first unread message

adc

unread,
Jan 20, 2010, 10:01:05 PM1/20/10
to Compass Development
Hey ya'll,
One thing that I think would really help developers and designers
adoption of Compass + Sass and such would be some really solid
documentation. For instance, when I was first getting into JQuery - it
was all about having the documentation open in one window - and my dev
stuff in another. And as far as documentation goes - I think JQuery
may provide a good model to follow.

However, I certainly realize that this sort of thing can be intensely
tedious and time consuming. The good news => there is already a ton of
content within the github wiki. (...Always best to build design from
the content outwards...) I think all that really needs to happen is
someway of organizing this info in a super accessible/searchable site
=> similar to the JQuery model.

Chris has already expressed that he doesn't have time (understandably)
for a project like this, but as a UI designer myself, I would be happy
to help out in any way I can with this aspect of the Compass project.

I just thought I would throw the topic out there. Is anyone else
working on any aspects of this yet - apart from the github wiki?

-Andrew

PS - as a total n00b here, here's a uber-brief into: My name is Andrew
Colclough. BS at the University of Oregon in multimedia design. Been
doing design and dev for about 9 years or so. Skillset => bridging the
gap between design and dev. Really focused on development though over
the last several years. Past projects I had the privilege to work on:
InstantAction.com, Playlegions.com, PlayLegions Facebook app. Stoked
about cutting edge web tech. Love to help out wherever and whenever I
can!

Chris Eppstein

unread,
Jan 20, 2010, 10:09:03 PM1/20/10
to compas...@googlegroups.com
I _am_ working on docs right now. like right now -- in my other window.

I have Charles Roper, Brandon Mathis, and yourself now as doc volunteers with Brandon leading the design and me leading the implementation.

I hope to get things soon to a state where new docs can be added in parallel to the design effort with enough infrastructure in place to make that go pretty quickly.

I will not be releasing v0.10 without good docs.

chris


--
You received this message because you are subscribed to the Google Groups "Compass Development" group.
To post to this group, send email to compas...@googlegroups.com.
To unsubscribe from this group, send email to compass-devs...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/compass-devs?hl=en.




Noel

unread,
Jan 20, 2010, 10:25:11 PM1/20/10
to compas...@googlegroups.com
I volunteer to proofread. 

Sent from my iPhone

Eric Meyer

unread,
Jan 28, 2010, 3:47:08 AM1/28/10
to Compass Development
I'm happy to help where I can with either some design/implementation
work or writing tutorials and samples. I'm ending the month crazy, but
I hope to slow down a bit in the next few weeks.

-e

On Jan 20, 8:25 pm, Noel <wwydi...@gmail.com> wrote:
> I volunteer to proofread.
>
> Sent from my iPhone
>
> On Jan 20, 2010, at 7:09 PM, Chris Eppstein <ch...@eppsteins.net> wrote:
>
>
>
> > I _am_ working on docs right now. like right now -- in my other  
> > window.
>
> > I have Charles Roper, Brandon Mathis, and yourself now as doc  
> > volunteers with Brandon leading the design and me leading the  
> > implementation.
>
> > I hope to get things soon to a state where new docs can be added in  
> > parallel to the design effort with enough infrastructure in place to  
> > make that go pretty quickly.
>
> > I will not be releasing v0.10 without good docs.
>
> > chris
>

Chris Eppstein

unread,
Jan 28, 2010, 4:28:24 AM1/28/10
to compas...@googlegroups.com
Documentation Update

Here are the reference docs generated for compass and blueprint and ready for human intervention:


If you're ready to contribute, read this:

I've tried to make things as simple as possible for generating new docs and maintaining the docs over time because I NEED your help on this. It will take me a month or more to fill out these docs if I'm doing it alone.

I've especially tried to make it as easy as possible to make examples like the one you see here:
because I think that examples are really useful and can be tedious.

Now, Go fork the code and check out the docs branch!

As far as process goes:

If you work on a documentation page and finish, please add this to the corresponding wiki page:

"ATTENTION: This wiki page has been ported to the new documentation system. Further edits will be lost."

If you're going to work on a new page, and don't finish promptly, please add a note to the corresponding wiki page that you are working on it to avoid conflicts.

Please let me know if you have any questions, suggestions, etc.

chris

Wolf

unread,
Jan 30, 2010, 1:29:39 PM1/30/10
to Compass Development
Chris,

how do I get the branches to display?

If I fork compass I only see the master branch.

Thanks!

W.

On Jan 28, 10:28 am, Chris Eppstein <ch...@eppsteins.net> wrote:
> Documentation Update
>
> Here are the reference docs generated for compass and blueprint and ready
> for human intervention:
>
> http://compass-style.org/docs/
>

> If you're ready to contribute, read this:http://github.com/chriseppstein/compass/blob/docs/doc-src/README.mark...


>
> I've tried to make things as simple as possible for generating new docs and
> maintaining the docs over time because I NEED your help on this. It will
> take me a month or more to fill out these docs if I'm doing it alone.
>
> I've especially tried to make it as easy as possible to make examples like
> the one you see here:http://compass-style.org/docs/reference/blueprint/grid/#mixin-pull
> because I think that examples are really useful and can be tedious.
>
> Now, Go fork the code and check out the docs branch!
>
> As far as process goes:
>
> If you work on a documentation page and finish, please add this to the
> corresponding wiki page:
>
> "ATTENTION: This wiki page has been ported to the new documentation system.
> Further edits will be lost."
>
> If you're going to work on a new page, and don't finish promptly, please add
> a note to the corresponding wiki page that you are working on it to avoid
> conflicts.
>
> Please let me know if you have any questions, suggestions, etc.
>
> chris
>

> > compass-devs...@googlegroups.com<compass-devs%2Bunsu...@googlegroups.com>


> > > > .
> > > > For more options, visit this group athttp://
> > groups.google.com/group/compass-devs?hl=en
> > > > .
>
> > > > --
> > > > You received this message because you are subscribed to the Google
> > > > Groups "Compass Development" group.
> > > > To post to this group, send email to compas...@googlegroups.com.
> > > > To unsubscribe from this group, send email to

> > compass-devs...@googlegroups.com<compass-devs%2Bunsu...@googlegroups.com>


> > > > .
> > > > For more options, visit this group athttp://
> > groups.google.com/group/compass-devs?hl=en
> > > > .
>
> > --
> > You received this message because you are subscribed to the Google Groups
> > "Compass Development" group.
> > To post to this group, send email to compas...@googlegroups.com.
> > To unsubscribe from this group, send email to

> > compass-devs...@googlegroups.com<compass-devs%2Bunsu...@googlegroups.com>

Chris Eppstein

unread,
Jan 30, 2010, 1:32:18 PM1/30/10
to compas...@googlegroups.com
git checkout -b docs --track origin/docs

I'm hanging out in #compass on freenode IRC if anyone needs help.

To unsubscribe from this group, send email to compass-devs...@googlegroups.com.
Reply all
Reply to author
Forward
0 new messages