On Thu, Nov 15, 2007 at 01:51:46PM -0800, David Roundy wrote:

Looks nice to me. I assume the idea is that we can expand this, so that for instance it could reference other files in contrib that are nicely documented, so that we could have a hierarchy of introductions to various increasingly complex ways you could configure your code?

This is in fact what I have in mind. Basically the availability of haddock commands and the possibility to link our code could be used for: 1. a general introduction to xmonad configuration (this is there, from CONFIG) 2. a description of name spaces and their content (Action, Config, Hooks, Layout, Prompt and Util) 3. more detailed examples? 4. what else? Later on I'll be pushing an amended patch, with a scratch of the above proposal so we can start talking of something we can put our hand on. I'll be also writing directions for helping with the documentation effort. If other people would like to join, even without a deep knowledge of Haskell (I started with documentation patches too), this is the right time to get darcs working for sending patches, and not just for pulling...;) Thanks, Andrea

On Fri, Nov 16, 2007 at 11:42:55AM +0200, Valery V. Vorotyntsev wrote:

On 11/16/07, Andrea Rossato wrote:

...

This is in fact what I have in mind. Basically the availability of haddock commands and the possibility to link our code could be used for:

Hi, Andrea,

Formatting warning: there are over-escaped characters in README.hs. They appear in rendered html [http://gorgias.mine.nu/xmonad/xmonad-contrib/README.html]:

~\/.xmonad\/xmonad.hs

Also, the file appears to be rendered from old xmonad/README, which contained typos. Those are already fixed in fresh xmonad, but not in contributed README.hs.

Please, forgive me -- I haven't read this patch carefully. Spotting typos is easy: eyes do automatic visual pattern recognition, even when the brain is in standby mode. :)

Have fun!

Hi Valery, that documentation was a bit outdated. I've just uploaded the new one, and pushed a patch that add that documentation to the XMC tree. Now I'm sending a message to explain it more clearly. Thank you. Andrea