On Mon, Feb 13, 2012 at 4:59 AM, Chris McDonough <[email protected]> wrote:
> Thanks to the amazing generosity of everyone here, it looks like we'll > be a "go" for a Pyramid documentation overhaul project (see the "need > your help to overhaul docs" thread for the genesis of this idea: > > http://groups.google.com/group/pylons-discuss/browse_thread/thread/7bd833209369bc5f). > We currently have a little over $3K in external pledges, and I have a > pretty good feeling we'll get some more over the next few months. > > I still have yet to actually collect the pledged funds; I've applied for > a Kickstarter.com project to do that, and I'm awaiting their response. > Once I get it I'll likely be asking folks who pledged to put those > pledges into that system. > > There is also a new open source kickstart competitor, haven't used it though: https://www.crowdtilt.com/ I have a really good feeling about what will come out of this effort, > and I hope you do too. I've created a page at > https://github.com/Pylons/pyramid/wiki/Documentationoverhaul describing > what I'd personally like to see done during the effort. My suggestions > are mostly about rearranging and prioritizing the content. Although I'd > really like to see shorter docs, I didn't mention at all any removals of > content because it's not terribly important to chop content unless it's > in the context of something printed on paper. In a print version we can > chop content very simply by not including the API reference (it's > 200 > pages long). We'll still want to tighten the wording and get rid of > overlong descriptions, but omitting the API reference is both reasonable > and easy for producing shorter printed versions of documentation. > > I think that is actually better. I've seen countless times books getting negative reviews for duplicating the online API reference, and it just doesn't make sense to have that in book form really, it's a case where the hypertext part of the web is so much better. Great job on this initiative Chris! hard to believe that the docs will get even better ( I already think they're the best out there ) but I'm sure they will! Iain -- 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.
