Jump to:

22977 Posts in 11742 Topics by 2826 members

General Questions

SilverStripe Forums » General Questions » Where are saphire framework docs?

General questions about getting started with SilverStripe that don't fit in any of the categories above.

Moderators: martimiz, Sean, biapar, Willr, Ingo, swaiba, simon_w

Page: 1
Go to End
Author Topic: 1583 Views
  • mauzer_tim
    Avatar
    Community Member
    11 Posts

    Where are saphire framework docs? Link to this post

    I'm choosing framework for my new project and consider to use saphire & SS to build the project on it. There is a slick promo page for Saphire: http://silverstripe.org/sapphire but all the documentation links on it lead to the documentation of SS itself. Where is the documentation of Saphire API?

  • Willr
    Avatar
    Forum Moderator
    5462 Posts

    Re: Where are saphire framework docs? Link to this post

    There is currently no separate cms / sapphire documentation. Its all sort of rolled into 1 in docs.

    For sapphire API level docs http://api.silverstripe.org/ is the place you want to go. Otherwise docs.silverstripe.org mostly covers sapphire based functionality as well (the cms provides very little extra functionality) things like the templates, controllers, forms which are all in the tutorials are sapphire framework concepts not cms specific.

    When the docs finally get round to being rebuild to use a new structure folders (http://groups.google.com/group/silverstripe-dev/browse_thread/thread/b9ee6dce8b7b5f1/940f4d23addb0482?lnk=gst&q=documentation#940f4d23addb0482) we will have sections relating to sapphire specific / cms specific features.

  • mauzer_tim
    Avatar
    Community Member
    11 Posts

    Re: Where are saphire framework docs? Link to this post

    Willr, many thanks for intelligible response.

    Now I see that there are quite good documentation on the different aspects of saphire (at the moment I'm not sure if it's needed to be separated from CMS docs) and the API documentation. My first misunderstanding was just because of a bit strange wiki SilverStrip team are using. I somehow got to the tutorials section and weren't able to went out from this section just because there wasn't clear link to the index page. Several hours later after starting to work with docs.silverlight.org I hardly recognized index link in this semi-transparent title:

    Of course it might be only mine mental problems

  • Willr
    Avatar
    Forum Moderator
    5462 Posts

    Re: Where are saphire framework docs? Link to this post

    Thanks for the point on the title. I guess it is a bit confusing and it doesn't have a link in the top nav either!. Reorganizing the documentation is high on the priority list for 2010. We're looking at moving to a totally different system some time in the future so the current docs have gone a bit unloved (its still using the old old silverstripe theme and menu )

  • QDK
    Avatar
    Community Member
    3 Posts

    Re: Where are saphire framework docs? Link to this post

    ^ This is excellent news. I have just discovered SilverStripe today. I have managed to get it installed with no problems, but hunting through docs for it has been quite exasperating! I still haven't managed to find how to enable the image editor!

  • Willr
    Avatar
    Forum Moderator
    5462 Posts

    Re: Where are saphire framework docs? Link to this post

    I still haven't managed to find how to enable the image editor!

    As far as I know this has been removed from the core release since it was too buggy for general usage.

  • QDK
    Avatar
    Community Member
    3 Posts

    Re: Where are saphire framework docs? Link to this post

    ah .. fair play

    1583 Views
Page: 1
Go to Top

Want to know more about the company that brought you SilverStripe? Then check out SilverStripe.com

Comments on this website? Please give feedback.