generated from fastn-stack/fastn-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.ftd
315 lines (206 loc) · 5.93 KB
/
index.ftd
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
-- import: fastn
-- import: ds
-- record post-data:
caption title:
body body:
optional ftd.image-src thumbnail:
integer index:
boolean is-left:
string link:
-- post-data list post:
-- post-data: How to setup continuous documentation for your Github Repo
index: 1
is-left: true
thumbnail: $assets.files.assets.images.setup-2.png
link: index.html
[Continuous Documentation](cdoc/), `cDoc` helps you keep your documentation up
to date with your changing code by blocking pull requests from getting merged
till documentation has been written and approved.
-- post-data: Taste Of `cDoc` on Day To Day
index: 2
is-left: false
thumbnail: $assets.files.assets.images.day-9.png
link: index.html
Yo Hello There! So you have [understood why continuous documentation is right
thing to improve your team's happiness](blog/cdoc/), and you have already [set
it for your repositories](blog/setup/), and are now *eager to start using it*.
You are in the right place!
-- post-data: Lack Of Documentation Is Costing You
index: 3
is-left: true
thumbnail: $assets.files.assets.images.developer-time.png
link: index.html
Lack of documentation is causing problems for you. If you do not have proper
documentation, onboarding a new team member is slow. It takes a lot of time for
that person to become productive. In at least one of the [Big
Tech](https://en.wikipedia.org/wiki/Big_Tech), a person moving from one team to
another and becoming productive takes 3 months.
-- post-data: Does Writing Documentation Slow You Down?
index: 4
is-left: false
thumbnail: $assets.files.assets.images.traffic.jpg
link: index
So documentation is important. And developers do understand the importance of
the documentation. So why do developers not write documentation? Is this
because writing documentation is extra work, and this extra work slows you down?
-- end: post
-- ds.page:
-- featured-article: Introducing `cDoc`: Continuous Documentation
thumbnail: $assets.files.assets.images.process.png
link: /
After much wait we are launching “Continuous Documentation” today!
One common problem that many tech companies face is that their documentation is
not up to date. Be it small teams or large, a 2 person startup or the Big Tech.
-- article-list:
list-of-posts: $post
-- end: ds.page
-- component featured-article:
caption title:
optional body body:
optional ftd.image-src thumbnail:
optional string author:
optional string timestamp:
string link:
-- ftd.column:
width: fill-container
background.solid if { ftd.device != "mobile" }: $inherited.colors.background.step-1
padding-vertical.px: 20
padding-horizontal.px if { ftd.device != "mobile" }: 20
border-radius.px: 12
margin-left.px if { ftd.device != "mobile" }: -20
-- ftd.row:
if: { ftd.device != "mobile" }
width: fill-container
spacing.fixed.px: 30
link: {$featured-article.link}
-- ftd.row:
align-self: start
width: fill-container
-- ftd.column:
width: fill-container
-- ds.h2: $featured-article.title
-- ds.markdown:
$featured-article.body
-- end: ftd.column
-- ftd.row:
if: { featured-article.thumbnail != NULL}
width.fixed.percent: 50
-- ftd.column:
align-self: center
width: fill-container
-- ftd.image:
src: $featured-article.thumbnail
width: fill-container
-- end: ftd.column
-- end: ftd.row
-- end: ftd.row
-- end: ftd.row
-- ftd.column:
if: { ftd.device == "mobile" }
width: fill-container
spacing.fixed.px: 30
link: $featured-article.link
-- ftd.row:
align-self: start
width: fill-container
-- ftd.column:
width: fill-container
-- ds.h2: $featured-article.title
-- ds.markdown:
$featured-article.body
-- end: ftd.column
-- ftd.row:
if: {$featured-article.thumbnail != NULL}
align-self: end
width: fill-container
-- ftd.column:
align-self: center
width: fill-container
-- ftd.image:
if: { ftd.device == "mobile"}
src: $featured-article.thumbnail
width: fill-container
-- end: ftd.column
-- end: ftd.row
-- end: ftd.column
-- ftd.row:
if: {$featured-article.author != NULL}
width: fill-container
margin-top.px: 24
border-top-width.px: 1
border-color: $inherited.colors.cta-tertiary.pressed
padding-top.px: 16
-- ftd.row:
align-self: start
width: fill-container
-- ftd.text: Author:
if: {$featured-article.author != NULL}
role: $inherited.types.fine-print
color: $inherited.colors.cta-tertiary.pressed
padding-top.px: 3
padding-right.px: 10
-- ftd.text: $featured-article.author
role: $inherited.types.label-big
color: $inherited.colors.cta-tertiary.pressed
-- end: ftd.row
-- end: ftd.row
-- ftd.row:
align-self: end
-- ftd.text:
if: { $featured-article.timestamp != NULL}
text: $featured-article.timestamp
role: $inherited.types.fine-print
color: $inherited.colors.cta-tertiary.pressed
white-space: nowrap
-- end: ftd.row
-- end: ftd.column
-- end: featured-article
-- component article-list:
post-data list list-of-posts:
-- ftd.row:
width: fill-container
margin-top.px: 30
background.solid if { ftd.device != "mobile" }: $inherited.colors.background.step-1
margin-left.px if { ftd.device != "mobile" }: -20
border-radius.px: 12
wrap: true
-- post-view:
$loop$: $article-list.list-of-posts as $obj
title: $obj.title
body: $obj.body
thumbnail: $obj.thumbnail
/index: $obj.index
is-left: $obj.is-left
link: $obj.link
-- end: ftd.row
-- end: article-list
-- component post-view:
string title:
string body:
ftd.image-src thumbnail:
string link:
/integer index:
boolean is-left:
-- ftd.row:
width.fixed.percent if { ftd.device != "mobile" }: 50
width if { ftd.device == "mobile" }: fill-container
-- ftd.column:
width: fill-container
padding-horizontal.px if { ftd.device != "mobile" }: 30
padding-top.px: 30
border-bottom-width.px if { ftd.device == "mobile" }: 1
border-bottom-width.px if { ftd.device != "mobile" }: 0
border-color: $inherited.colors.cta-tertiary.pressed
-- ftd.column:
link: $post-view.link
width: fill-container
-- ftd.image:
src: $post-view.thumbnail
width: fill-container
-- ds.h3: $post-view.title
-- ds.markdown:
$post-view.body
-- end: ftd.column
-- end: ftd.column
-- end: ftd.row
-- end: post-view