[smart] Some documentation plans

[Gustavo Niemeyer]

I'd like to share with you some plans for the forthcoming
future regarding the documentation of Smart.

Now that we're using moin to store our web content, we're
able to do more fine grained access control on certain parts
of the site, and have nice features to control joint development
of content.

With that in mind, I'd really like to count with some help on
the development of these papers.

So, the following items would be an excellent startup already.
Feel free to add new items on that list. If you want to startup
the development of one of these documents, just let me know and
we'll arrange direct access to page editing.

- FAQ

  Questions, and answers. :-) There're already some (perhaps a bit
  out of date) questions and answers by Guilherme Manika.

- Basic usage

  This would include basic information about how to install packages,
  remove packages, description of the basic software behavior, etc.

- Generic basic setup for each backend

  Perhaps part of the above item, including information about how to
  use Smart with each backend, focusing on the specific details about
  each one.

- -o options

  Information about which options are available and what they do.
  Perhaps another subitem on the above topics.

- Setup of each channel type

  Extendend information (at least more than what is on --help) about
  how to use each channel type (what each channel option expects, etc).

- Case studies

  Basically porting information on the README, and including new
  items.

- Distributing Smart

  Focusing more on the distribution site of Smart, like setting up
  distro.py, etc.

- Different environments

  How to use Smart in other environments, like under chroots,
  multiple system channels, etc.


What do you think?

-- 
Gustavo Niemeyer
http://niemeyer.net