http://www.silverstripe.org/home/ http://www.silverstripe.org/content-is-king-documentation-for-silverstripe/#PageComment_9268 "Beginners are most interested in step-by-step tutorials."
"Advanced users are probably more interested in extensive descriptions of specific features, recipes, and of course the API documentation."

I disagree. When I was a beginner, I LOVED jQuery's API docs (and I still do). I have /never/ used any other offical jQuery docs than the API docs.

If you want an example of API documentation done RIGHT, look at jQuery's:
http://api.jquery.com/addClass/

Compare to SS's:
http://api.silverstripe.org/2.4/sapphire/filesystem/Upload.html Fri, 03 Feb 2012 17:27:51 +1300 Nathan J. Brauer http://www.silverstripe.org/content-is-king-documentation-for-silverstripe/#PageComment_9268 http://www.silverstripe.org/content-is-king-documentation-for-silverstripe/#PageComment_9222 Phillip,

I agree with the ideas Jose has given, especially the idea of a "big" web project tutorial.

One framework that I found to have excellent docs was symfony, during their 1.x releases. They had a 24-part series of building a job board from scratch, and it exercised all parts of the framework.

And Django always had decent docs, though I haven't seen them in a while. One CMS that always struggled, though, was Plone. It always felt like their docs were scattered and haphazard, and there seemed to be a lot of disagreement on the doc mailing list.

And one last example, when Microsoft's MVC 2 came out, they had a 100+ page tutorial that walked through building a website.

I'll try to pitch in once the beta comes out.

Alex M. Sat, 21 Jan 2012 12:26:00 +1300 Alex M http://www.silverstripe.org/content-is-king-documentation-for-silverstripe/#PageComment_9222 http://www.silverstripe.org/content-is-king-documentation-for-silverstripe/#PageComment_9216 Thanks for the feedback!
We'll try to keep it in mind. It's probably hard to provide examples for the whole API, but we'll add more examples of how to put it all together :-) Fri, 20 Jan 2012 12:58:06 +1300 Philipp http://www.silverstripe.org/content-is-king-documentation-for-silverstripe/#PageComment_9216 http://www.silverstripe.org/content-is-king-documentation-for-silverstripe/#PageComment_9215 Hi Phillip,

I have been working through both your book as well as Ingo's book and have found the material, tutorials and examples priceless. It has really helped me develop in Silverstripe. I am very excited to see that the Silverstripe framework is now being released separately and after looking at Cakephp and comparing that with how Silverstripe aproaches MVC i must say that i appreciate the work that you guys have been doing even more.

If there is one thing that i would like to see in your next book is more information on how the API works/ how to use the API, maybe it is just me or maybe i missed something in the books but i don't always understand how to apply the info in the API documentation eg.. can the code be used in the view, or in the model or controller or all of the above.

Php.net for example will show you the api and then an example to illustrate how it works. It makes it easier for a novice like myself to understand the practical implications of using the code.

Anyway... thanks for the awesome work

Fri, 20 Jan 2012 11:08:26 +1300 Shaun http://www.silverstripe.org/content-is-king-documentation-for-silverstripe/#PageComment_9215 http://www.silverstripe.org/content-is-king-documentation-for-silverstripe/#PageComment_9189 Hello Philipp,

I completely agree with you.
The main SilverStripe tutorial should be a big web project with all the basic features of a modern web, auto-rotating images, video, image galleries, news, blog, forum, user statistics, contact form, registry form, login form, shopping cart, searching, page layout ( grid systems, ...), PDF invoice, Internationalization, newsletters, protected download pages, mobile Web, RSS, Facebook, Twitter, Tuenti, Myspace links, and so on.

The more extensive and detailed, new users can easily start creating their own websites and more easily will become famous SilverStripe.

FAQ Area (common problems in the installation, CMS management, image upload, ...).

A more detailed API documentation with examples.

The essential modules (blog, forum, shopping cart) should be improved enough to cover most current requirements.

Special page with all the SilverStripe 3 news with links to documentation that explains in detail and with examples all the improvements.

Detailed special documentation to upgrade from SilverStripe 2.4 to SilverStripe 3.

The documentation should be ready for the release of SilverStripe 3.

Regards,
Jose A. Tue, 17 Jan 2012 00:06:06 +1300 Jose A http://www.silverstripe.org/content-is-king-documentation-for-silverstripe/#PageComment_9189 http://www.silverstripe.org/content-is-king-documentation-for-silverstripe/#PageComment_9188 I've written some documentation guidelines a while back for anybody that wants to get started: http://doc.silverstripe.org/sapphire/en/misc/contributing#writing-documentation - yay for meta documentation ;) Mon, 16 Jan 2012 21:04:46 +1300 Ingo http://www.silverstripe.org/content-is-king-documentation-for-silverstripe/#PageComment_9188