Default Modules & Other Documentation

Gravatar PolarLava

  • Posts: 7
  • Topic Created: Sun Jun 26 23:28:05 2011 +0200

Arian,

Here's a mundane request...all of the default modules that ship with Chyrp need to uploaded to the Modules section. They should be marked as "This is part of the default Chyrp installation." This way there is some clear public documentation of the modules and it's easy for people to grab then when they are updated.

It might also be nice to develop some documentation for the less technically savvy with at least some basic "here's how to start" and then from there. Wiki perhaps?

I'm guessing you'll agree these are good ideas, but have a limited amount of time to do some of these things. I understand, I'm likely to disappear for several weeks again myself. I'll have more time later in the year and I'll try to help out as I can. The wiki would allow anyone that wants to take a few minutes to help out to do so. Documentation is boring, but it's a necessary evil.

Gravatar Arian

Well Kevin, granted documentation is a concern I've been having ever since I took over. I couldn't agree more, but you figured the constrains already.

I'm in the proces of redesigning the whole site here. Been working intensively for the past two days with my brother and we came out very close. I'm thinking the structure very detailedly, so rest assured docs will have a special treatment.

I myself, have next two busy weeks with other stuff, and I believe increased work activity will be noticed after that.

We have this wiki at our github repo https://github.com/chyrp/chyrp/wiki where anyone with a github account can hop in and extend it, but it's a matter of free will, thus Chyrp's Docs are left in the hands of mercy.

I can't stress it enough when I express my gratitude out to everybody who's helping here and there, cuz at times it gets hard to be everywhere at once and by myself.

P.S. Started working on extending the "extend" section here, apply some restrictions, more info and filter out stuff when necessary. Will follow your suggestion and put all the core modules and feathers there.