Documentation

[marcustisater]

There should be some very good documentation of PostCSS on the website. Here are some quick initial ideas;

• How to get started
• Developer API
• PostCSS in a nutshell

etc...

There are already some very good documentation on the PostCSS GitHub page that we can use.

[MoOx]

And probably some good idea http://webdesign.tutsplus.com/series/postcss-deep-dive--cms-889

[ai]

We have a special section in README.md right now with most important docs:
https://github.com/postcss/postcss#articles

[marcustisater]

If someone is contributing with documentation they have to agree by Creative Commons Legal Code Attribution 3.0. This is something we need to have in the repository listed.

[ai]

BTW, why we use here CCPL 3.0, and not CC-BY-4.0?

[marcustisater]

Ok, CC-BY-4.0 is fine by me. Is that what you are using on PostCSS repo?

[ai]

Nope, we use MIT in PostCSS. We use CC-BY in PostCSS Brand repo.

[marcustisater]

Ok, let's go with CC-BY-4.0, let me set it up.

[marcustisater]

Once we have established a nice sitemap for the documentation part, I can start creating issues that would need "content/documentation". Maybe we should use the GitHub wiki?

#48

[mxstbr]

@marcustisater if we have the documentation in Markdown files in the repo, we can generate the website from that. If it's in the wiki, that isn't possible.

[marcustisater]

Yeah that's a good point but I'd figured maybe the GitHub Wiki can be easier to contribute with and maybe we can add some overview planning on what's done and what's not in the wiki as well.

Do you think it's worth investigating into more if it's worth adding it in? I haven't used it at all to be honest...

[mxstbr]

A wiki is nicer for collaboration, but we'd essentially have to copy & paste every change which is a pita. I don't think it's worth investigating tbh, there's a lot of documentation at postcss/postcss in Markdown already: https://github.com/postcss/postcss/tree/master/docs

[marcustisater]

Yeah, you're right. I didn't think about that part... 😊

[MoOx]

That's a reason why I included cssnext website in cssnext repo itself: to avoid redundancy and make maintenance easier. And I am pretty happy with this choice.

[marcustisater]

All that we need is a good README file that explains how to contribute with content for the website.

[marcustisater]

I can set one up.

[marcustisater]

Feel free to edit if needed.

#73

[marcustisater]

breaking this down into more issues, my fault.