-
Notifications
You must be signed in to change notification settings - Fork 65
/
guides.yml
191 lines (189 loc) · 8.45 KB
/
guides.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
title: SproutCore Guides
description: These guides are designed to help you write and perfect your code.
team_name: The People That Make It Happen
authors:
Documentation Team:
- name: Peter Wagenet
nick: pwagenet
image: credits/pwagenet.jpg
description: Peter Wagenet
- name: Yehuda Katz
nick: wycats
image: credits/ykatz.jpg
description: Yehuda Katz
Contributors:
- name: Mike Ball
nick: onkis
image: credits/mball.png
description: Mike Ball
- name: Peter Bergstrom
nick: pbergstrom
image: credits/pbergstrom.jpg
description: Peter Bergstrom
- name: Kyle Carriedo
nick: kcarriedo
description: Kyle Carriedo
- name: Tom Dale
nick: tomdale
image: credits/tdale.jpg
description: Tom Dale
- name: Geoffrey Donaldson
nick: geoffreyd
image: credits/gdonaldson.jpg
description: Geoffrey Donaldson
- name: Chad Eubanks
nick: ceubanks
description: Chad Eubanks
- name: Topher Fangio
nick: topherfangio
image: credits/tfangio.jpg
description: Topher Fangio
- name: Jason Gignac
nick: jgignac
description: Jason Gignac
- name: Vibul Imtarnasan
nick: veebs
image: credits/vimtarnasan.jpg
description: Vibul Imtarnasan
- name: Alex Iskander
nick: ialexi
description: Alex Iskander
- name: Tyler Keating
nick: publickeating
image: credits/tkeating.jpg
description: Tyler Keating
- name: Florian Kugler
nick: fkugler
image: credits/fkugler.jpg
description: Florian Kugler
- name: Shawn Morel
nick: shawnmorel
description: Shawn Morel
- name: Erich Ocean
nick: erichocean
image: credits/eocean.jpg
description: Erich Ocean
- name: Piotr Sarnacki
nick: drogus
image: credits/psarnacki.jpg
description: Piotr Sarnacki
- name: Scott Smith
nick: oldfartdeveloper
image: credits/ssmith.jpg
description: Scott Smith
- name: Majd Taby
nick: mtaby
description: Majd Taby
- name: Devin Torres
nick: dtorres
image: credits/dtorres.jpg
description: Devin Torres
- name: Greg Moeck
nick: gmoeck
description: Greg Moeck
index:
Start Here:
- title: "Getting Started: Part 1"
url: getting_started
text: "Learn how to get your first SproutCore app up-and-running."
- title: "Getting Started: Part 2"
url: getting_started_2
text: "Spring forward with the information you learned in Part 1 and learn about statecharts and views."
- title: "Getting Started: Part 3"
url: getting_started_3
text: "Expand upon your knowledge from the first two guides, and build a full-scale Todos application."
- title: "Classes and SC.Object"
url: core_concepts_sc_object
text: "In this guide, we will touch on SC.Object, the basis for SproutCore's class-like object-oriented programming structure."
- title: "Computed Properties, Observers and Bindings"
url: core_concepts_kvo
text: "In this guide, we will touch on KVO in SproutCore."
Views:
- title: Core View Concepts
url: views
text: "In this guide, we will cover the basics of SproutCore views, and show you how to customize the built-in SproutCore views for your own use."
- title: Building Your Own Views
url: custom_views
text: "Most applications will quickly go beyond the built-in SproutCore views. In this guide, we will cover how to build and style your own views."
construction: true
- title: Animations
url: animate
text: "In this guide, we will cover the basics of using animations in SproutCore, and show you how to add SC.View#animate in your code."
construction: true
Models:
- title: SproutCore Records
url: records
text: "The SproutCore data framework is a full-featured ORM-like framework for working with data in SproutCore. Learn about the SproutCore data framework and how you can use it to interact with your data sources."
- title: Understanding the Record Lifecycle
url: record_lifecycle
text: "Records in SproutCore travel through a series of simple statuses. Understanding these statuses can help you to build better, less buggy SproutCore apps. This guide walks you through a description of the details of the lifecycle of a record."
construction: true
- title: Hooking Up to a Backend
url: connect_server
text: "Learn how to connect your SproutCore app to your backend server."
construction: true
- title: Creating a DataSource
url: data_source
text: "This guide covers how to create a SproutCore data source, which will retrieve data from your servers and make them available to the SproutCore Records you designed in the previous guide."
construction: true
- title: Transactions Using Nested Stores
url: nested_stores
text: "SproutCore provides a powerful facility for allowing your app's users to make changes to local data, then commit or rollback the changes as needed. Learn how to use 'nested stores' to manage the state of your data as it moves through your user's edits."
construction: true
- title: Using Fixtures
url: fixtures
text: "In order to facilitate rapid development, SproutCore provides a facility for using pre-set fixture data as your data source. This guide covers how to set up your fixtures, and how to replace them with your real server once you're ready to get going."
Theming:
- title: "Using Chance, SproutCore's CSS Framework"
url: chance
text: "Chance is SproutCore's CSS preprocessor. In this guide, you will learn how to use the CSS extensions that come with Chance to streamline your styling workflow."
- title: Theming Your App
url: theming_app
text: "In this guide, we'll cover how to change the style of SproutCore controls in your app. As an example, we'll re-theme an SC.ButtonView."
- title: Writing Themeable Controls
url: themeable_controls
text: "In this guide, we'll go over to how to develop a control that can be themed. This can be useful if you want to have different visual displays in your application (like a regular and overlay theme) or when distributing a theme for wider use."
construction: true
Testing:
- title: "Unit Testing"
url: unit_test_framework
text: "SproutCore has an easy-to-learn unit test facility that can be used to drive SproutCore test-driven development. This guide describes the basic SproutCore test commands."
- title: "Adding a Unit Test"
url: adding_unit_test
text: "Adding a unit test automatically or manually."
- title: "Writing Unit Tests"
url: writing_unit_tests
text: "Describes how to write unit tests using module and test functions"
- title: "Running Unit Tests"
url: running_unit_tests
text: "How tests are loaded and executed by the test runner."
- title: "Testing Guidelines in SproutCore"
url: testing_guidelines
text: "Developing a SproutCore application using test-driven development (TDD)."
construction: true
- title: "SproutCore Development Using TDD"
url: todos_tdd
text: "Show implementing the TODOs project using TDD."
Extras:
- title: Build Tools
url: build_tools
text: "Discover the many performance advantages and development benefits of SproutCore's build tools."
- title: "The Run Loop"
url: run_loop
text: "An indepth look at SproutCore's Run Loop for an advanced understanding of the framework."
- title: Enumerables
url: enumerables
text: "To simplify working with various kinds of lists, SproutCore provides a unified Enumerable interface. This guide explores which SproutCore objects are Enumerable, and how to use the Enumerable API."
- title: Using Handlebars Templates
url: using_handlebars
text: "Learn how to make your application come to life by leveraging the tight integration between SproutCore and Handlebars, a semantic templating language."
Contributing to SproutCore:
- title: "Javascript Style Guide"
url: "style_guide"
text: "This guide covers the style of SproutCore framework code."
- title: "Committer Guidelines"
url: "commit_code"
text: "A detailed checklist of the do's and don'ts of SC framework code."
- title: "Documentation Guidelines"
url: "documentation_guidelines"
text: "Writing and generating jsdoc documentation."