On Feb 27, 11:36 am, Ben Bangert <[EMAIL PROTECTED]> wrote: > > I think at this point, I'm looking at moving all docs to a Moin wiki, > and cloning it to handle doc updates (ie, the 0.9 docs will be one > wiki with its pages 'frozen', while 1.0 will be another so that > people can get to both). This way people can fill in the sections > they want to talk about, and hopefully others will edit them for > grammar/spelling and try to ensure the 'tone' is fairly consistent.
Ben, could you elaborate on this some more? I've found the docs on turbogears and django to be really hard to follow because they are version specific, but I understand why it must be done. The "best" doc system depends on the perspective of the end user. Newbies want one set of docs, older developers stuck on a specific legacy version may need different docs. When you have a latest and greatest best practices doc, do people looking at 9.1 docs not see that? This is a problem in general with fast moving OSS projects where bugfixes go into the latest rev of the trunk and are not backported to previous versions. It doesn't seem practical to backport docs either. In addition, there's the web of documentation for supporting projects. Docs for dealing with session state will be fairly different depending on what version of pylons / orm you're using. Do you intend to link the supporting projects documentation as well? So in essence, if you have pylons 9.4.1 docs tree do you state in your docs that this works with sql alchemy 0.3.5 and link references to sql alchemy as http://www.sqlalchemy.org/docs_03/ ? davep --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "pylons-discuss" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/pylons-discuss?hl=en -~----------~----~----~----~------~----~------~--~---
