-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
executable file
·608 lines (536 loc) · 28.2 KB
/
index.html
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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Todofy Documentation</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="Ivor">
<!-- Le styles -->
<link href="assets/css/bootstrap.css" rel="stylesheet">
<link href="assets/ui/css/ui.css" rel="stylesheet">
<link href="assets/js/google-code-prettify/prettify.css" rel="stylesheet">
<link rel="shortcut icon" href="https://todofy.org/resources/success.ico" type="image/x-icon">
<link rel="icon" href="https://todofy.org/resources/success.ico" type="image/x-icon">
<style type="text/css">
body {
padding-top: 60px;
padding-bottom: 40px;
}
.info {
font-size: 12pt;
}
blockquote {
font-size: 10pt;
color: #333;
}
.clearfix {
display: block;
height: 10px;
width: 100%;
}
</style>
<link href="assets/css/bootstrap-responsive.css" rel="stylesheet">
<!-- Le HTML5 shim, for IE6-8 support of HTML5 elements -->
<!--[if lt IE 9]>
<script src="//html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<!-- Le fav and touch icons -->
<link rel="shortcut icon" href="images/favicon.ico">
<link rel="apple-touch-icon" href="images/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
</head>
<body data-spy="scroll" id="top">
<!-- Documentation Navbar -->
<div class="navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </a>
<a class="brand" href="http://todofy.org">Todofy</a> <!-- TIP: Change this for the name of your file -->
<div class="nav-collapse">
<ul class="nav">
<li><a href="#top" class="active">Home</a></li>
<li><a href="#signup">Sign Up</a></li>
<li><a href="#repo">Repositories</a></li>
<li><a href="#todofy">Todofication</a></li>
<li><a href="#suplang">Supported Languages</a></li>
<li><a href="#format">Format</a></li>
<li><a href="#labels">Labels</a></li>
<li><a href="#tags">Tags</a></li>
<li><a href="#deadline" >Deadline</a></li>
<li><a href="#reminder" >Reminder</a></li>
<li><a href="#priority" >Priority</a></li>
<li><a href="#gissue" >Issue</a></li>
<li><a href="#discussion" >Discussions</a></li>
<li><a href="#toread" >To Read</a></li>
</ul>
</div>
</div>
</div>
</div> <!-- End of Navbar -->
<!-- Main Container Beginning -->
<div class="container">
<div class="masthead">
<h1>Todofy Documentation</h1>
<p>Simple, flexible and extensive todo manager for your software development projects, Crafted with ♥ by <a href="http://todofy.io">todofy</a></p>
<p class="download-info"> <a href="https://todofy.org/api/login/" class="btn btn-primary btn-large">Sign up using Github</a></p>
</div> <!-- masthead -->
<div id="intro">
<p class="highlight hero-unit">By this time there are around <strong> ~ 89 million</strong> <code>TODO</code>, <strong> ~ 45 million</strong> <code>FIXME</code> and several other <code>HACK</code>, <code> TBD</code> etc in Github repositories. Using todofy one can keep track of their todos, and use other features to make sure they finish those. </p>
</div> <!-- intro -->
<section id="signup">
<div class="page-header">
<h1>Signup <small>Simply login using Github Account</small></h1>
</div>
<div class="info">
It's very very easy. You can sign in / sign up any time using Github. Click <a href="https://todofy.org/api/login/" title="login now">here</a> to sign in / sign up now!
<div style="margin: 10px">
<img src="./assets/img/oauth.png" alert="OAuth Permissions" style="max-width: 600px">
</div>
<blockquote>Todofy requires your permission to read your email id, read/write access to all your public repositories and read-access to your organizations and teams. This is needed to check collaborator access to repositories and add webhooks to track status of all todos after each commit. We do not need write permission to your public repositories, but it comes bundled in. It's all about trust :)</blockquote>
</div>
</section> <!-- signup -->
<section id="repo">
<div class="page-header">
<h1>Repositories <small>Integrate all your public repositories and organisation reporitories!</small></h1>
</div>
<div class="info">
When you sign up, we list out each of your public repositories and organizations repositories. Also, you can refresh this list anytime from your profile page.
<div style="margin: 10px">
<img src="./assets/img/repo_refresh.png" alt="repo refresh feature" style="max-width: 600px">
</div>
You can refresh using the <code>Sync button</code> on <code>top right</code>.
<br>
<br>
<br>
<h3>Organizational repositories</h3>
You can visit any organization page by visiting their url <code>https://todofy.org/r/<org name></code>.
<br>
For example: <a href="https://todofy.org/r/todofy">https://todofy.org/r/todofy</a>.
<br>
<br> Or if you are a team member / collaborator at any organization, you can view them on your profile page by clickin on the listed organizations.
<div style="margin: 10px">
<img src="./assets/img/org_repo.png" alt="org_repos" style="max-width: 600px">
</div>
</div>
</section> <!-- repo -->
<section id="todofy">
<div class="page-header">
<h1>Todofication <small>Todofy a repository once, and we will sync every commits you push!</small></h1>
</div>
<div class="info">
You can todofy a repository from your profile page, or by visiting the repository page at: <code>https://todofy.org/r/<repo full name></code>.
<div style="margin: 10px">
<img src="./assets/img/repo_todofy.png" alt="org_repos" style="max-width: 600px">
</div>
<br>
Note that you can todofy multiple repositories at any time but they are queued up and done one by one. Also, note that todofication time depend on size of repository and no of branches. Once the repository is todofied, the summary is sent to all the collaborators of the project. After todofication of the master branch is finished it will start listing out all active todos:
<div style="margin: 10px">
<img src="./assets/img/full_screenshot.png" alt="org_repos" style="max-width: 1000px">
</div>
<br>
<br>
<div class="alert">
<a class="close" data-dismiss="alert">×</a>
<strong>Warning!</strong> This section is a draft now, It doesn't contain information on:
<br>
<br>
<ul>
<li>Adding a badge to your README</li>
<li>Using search to filter todos in the list.</li>
<li>Hide a todo.</li>
<li>Using filters - priority, labels, languages</li>
<li>Grouping in category</li>
<li>Viewing all todos - including those from ignored files.</li>
<li>Ignoring files from todolist.</li>
<li>Removing a repository from Todofy.</li>
</ul>
</div>
</div>
</section> <!-- todofy -->
<section id="suplang">
<div class="page-header">
<h1>Supported Languages</h1>
</div>
<div class="info">
Following languages are supported:<br><br>
<span class="label">C</span>
<span class="label">C++</span>
<span class="label">Javascript</span>
<span class="label">Java</span>
<span class="label">GO</span>
<span class="label">PHP</span>
<span class="label">Python</span>
<span class="label">Ruby</span>
<span class="label">Typescript</span>
<span class="label">Rust</span>
<span class="label">HTML</span>
<span class="label">ASP</span>
<span class="label">JSP</span>
<span class="label">XML</span>
<span class="label">CSS</span>
<span class="label">C#</span>
<span class="label">Matlab</span>
<br><br>
And we are working to integrate more and more languages. You can request us to add support to new language at <a href="https://todofy.org/contact">contact page</a>.
</div>
</section> <!-- format -->
<section id="format">
<div class="page-header">
<h1>Comment format <small>You can do a variety of stuffs just by a simple comment in your code!</small></h1>
</div>
<div class="info">
You need to add a comment in any supported language, with todo informaiton.
<div class="widget black">
<div class="body" style="padding: 0px">
<div class="tabbedSpace">
<div class="tabheader">
<div class="tab selected" for="C/C++">C / C++</div><div class="tab" for="php">php</div><div class="tab" for="Javascript">Javascript</div><div class="tab" for="Python">Python</div><!-- <div class="tab" for="Ruby" >Ruby</div><div class="tab" for="TypeScript" >TypeScript</div> --><div class="tab" for="HTML">HTML</div><!-- <div class="tab" for="CSS" >CSS</div> -->
</div>
<div class="tabBody">
<div class="tab selected" for="C/C++">
<span class="tcomment">// <span class="tspl">TODO</span>: make this function more structured and compact</span><br>
<span class="tcomment">// and nice @<span class="tspl">deadline</span>: 1 week @<span class="tspl">reminder</span> 3 days</span><br>
<span class="tcomment">// @<span class="tspl">tags</span> - ben, tim, hawk @<span class="tspl">labels</span>: refactoring</span><br>
node *<span class="tfunction">getNode</span>( <span class="tdatatype">bool</span> last ) {<br>
<span class="ttabspace"></span>node *n = new node;<br>
<span class="ttabspace"></span><span class="tkeyword">for</span>( <span class="tdatatype">int</span> i = <span class="tconstant">0</span>; i < <span class="tconstant">26</span>; i++ ) {<br>
<span class="ttabspace"></span><span class="ttabspace"></span>n->ptrs[i] = <span class="tconstant">NULL</span>;<br>
<span class="ttabspace"></span>}<br>
}
</div>
<div class="tab" for="php">
<span class="tcomment">/*</span><br>
<span class="ttabspace"></span><span class="tcomment"><span class="tspl">TODO</span>: make this function more structured and compact</span><br>
<span class="ttabspace"></span><span class="tcomment">and nice @<span class="tspl">deadline</span>: 1 week @<span class="tspl">reminder</span> 3 days</span><br>
<span class="ttabspace"></span><span class="tcomment">@<span class="tspl">tags</span> - ben, tim, hawk @<span class="tspl">labels</span>: refactoring</span><br>
<span class="tcomment">*/</span><br>
<span class="tdatatype">function</span> <span class="tfunction">concatTrimmedElems</span>( $arr ) {<br>
<span class="ttabspace"></span>$out = ' ';<br>
<span class="ttabspace"></span><span class="tkeyword">foreach</span> ( $arr as $value ) {<br>
<span class="ttabspace"></span><span class="ttabspace"></span>$out .= <span class="tfunction">trim</span> ( $value );<br>
<span class="ttabspace"></span>}<br>
<span class="ttabspace"></span><span class="tkeyword">return</span> $out;<br>
}
</div>
<div class="tab" for="Javascript">
<span class="tcomment">/*</span><br>
<span class="ttabspace"></span><span class="tcomment"><span class="tspl">TODO</span>: make this function more structured and compact</span><br>
<span class="ttabspace"></span><span class="tcomment">and nice @<span class="tspl">deadline</span>: 1 week @<span class="tspl">reminder</span> 3 days</span><br>
<span class="ttabspace"></span><span class="tcomment">@<span class="tspl">tags</span> - ben, tim, hawk @<span class="tspl">labels</span>: refactoring</span><br>
<span class="tcomment">*/</span><br>
<span class="tdatatype">function</span> <span class="tfunction">concatTrimmedElems</span>( arr ) {<br>
<span class="ttabspace"></span><span class="tdatatype">var</span> out = ' ';<br>
<span class="ttabspace"></span><span class="tkeyword">for</span> ( <span class="tdatatype">var</span> i = 0; i < arr.<span class="tkeyword">length</span>; i++) {<br>
<span class="ttabspace"></span><span class="ttabspace"></span>out += arr[i].<span class="tfunction">trim</span>( );<br>
<span class="ttabspace"></span>}<br>
<span class="ttabspace"></span><span class="tkeyword">return</span> out;<br>
}
</div>
<div class="tab" for="Python">
<span class="tcomment">'''</span><br>
<span class="ttabspace"></span><span class="tcomment"><span class="tspl">TODO</span>: make this function more structured and compact</span><br>
<span class="ttabspace"></span><span class="tcomment">and nice @<span class="tspl">deadline</span>: 1 week @<span class="tspl">reminder</span> 3 days</span><br>
<span class="ttabspace"></span><span class="tcomment">@<span class="tspl">tags</span> - ben, tim, hawk @<span class="tspl">labels</span>: refactoring</span><br>
<span class="tcomment">'''</span><br>
<span class="tdatatype">def</span> <span class="tfunction">concatTrimmedElems</span>( arr ) :<br>
<span class="ttabspace"></span>out = ' ';<br>
<span class="ttabspace"></span><span class="tkeyword">for</span> elem <span class="tkeyword">in</span> arr :<br>
<span class="ttabspace"></span><span class="ttabspace"></span>out += arr[i];<br>
<span class="ttabspace"></span><span class="tkeyword">return</span> out;<br>
<br>
</div>
<div class="tab" for="HTML">
</<span class="tkeyword">div</span>><br>
<<span class="tkeyword">div</span> <span class="tfunction">class</span>="<span class="tstring">tab</span>" <span class="tfunction">for</span>="<span class="tstring">Python</span>"><br>
</<span class="tkeyword">div</span>><br>
<span class="tcomment"><!--</span><br>
<span class="ttabspace"></span><span class="tcomment"><span class="tspl">TODO</span>: make this function more structured and compact</span><br>
<span class="ttabspace"></span><span class="tcomment">and nice @<span class="tspl">deadline</span>: 1 week @<span class="tspl">reminder</span> 3 days</span><br>
<span class="ttabspace"></span><span class="tcomment">@<span class="tspl">tags</span> - ben, tim, hawk @<span class="tspl">labels</span>: refactoring</span><br>
<span class="tcomment">--></span><br>
<<span class="tkeyword">div</span> <span class="tfunction">class</span>="<span class="tstring">tab</span>" <span class="tfunction">for</span>="<span class="tstring">HTML</span>"><br>
</<span class="tkeyword">div</span>>
</div>
</div>
<div class="tabFooter">
This will add a todo <strong>make this function more structured and compact and nice</strong><br>
Tag Github users: <span class="label spl">ben</span> <span class="label spl">tim</span> <span class="label spl">hawk</span> and add a label <span class="label spl">refactoring</span> to the repo.
<div class="clearfix"></div>
<div class="clearfix"></div>
Also, it will add a deadline of <strong>1 Week</strong>, and user will be reminded <storng>4 days</storng> prior to that as well.
<div class="clearfix"></div>
<div class="clearfix"></div>
<div class="clearfix"></div>
<div class="clearfix"></div>
<div class="clearfix"></div>
<div class="clearfix"></div>
</div>
</div>
</div>
</div>
</div>
</section> <!-- format -->
<section id="labels">
<div class="page-header">
<h1>Labels <small>Add labels to group your todos to categories!</small></h1>
</div>
<blockquote>
Labels are used to group similar todos into categories and thus for filtering todos in the list.
Here's information how you can add it both using the dashboard and directly while adding todo.
</blockquote>
<h3> From the dashboard: </h3>
<div class="clearfix"></div>
You can also add labels without modifying the comments directly from the dashboard. Go to the todo page on Todofy and in the right hand menu, click on labels and select an existing one or add a new one.
<div style="margin: 10px">
<img src="./assets/img/labels.png" alt="labels" style="max-width: 600px">
</div>
<div class="clearfix"></div>
<div class="clearfix"></div>
<h3> Directly in code comment: </h3>
<div class="clearfix"></div>
You can add labels by adding <code>@label</code> parameter in your comments. For example in C++:
<div class="clearfix"></div>
<pre>
int getSum(int a, int b) {
// TODO: make this a template function @label: template, modification
return a + b;
}</pre>
This will add labels <code>template</code> & <code>modification</code> to this todo.
</section> <!-- labels -->
<section id="tags">
<div class="page-header">
<h1>Tags <small>Tag other users to pull them to disucssion!</small></h1>
</div>
<blockquote>
You can tag other users in a todo to notify them and bring them to discussion. As soon as a tag is added,
Todofy notifies respective users about the todo.
</blockquote>
<h3> From the dashboard: </h3>
<div class="clearfix"></div>
You can also tag users without modifying the todo comments directly from the dashboard. Go to the todo page and in the right hand menu, click on Tags and select an existing one or add a new one by entering their Github username.
<div style="margin: 10px">
<img src="./assets/img/labels.png" alt="labels" style="max-width: 600px">
</div>
<div class="clearfix"></div>
<div class="clearfix"></div>
<h3> Directly in code comment: </h3>
<div class="clearfix"></div>
You can Tag users with their Github username using <code>@tag</code> parameter in your comments. For example in C++:
<div class="clearfix"></div>
<pre>
int getSum(int a, int b) {
// TODO: make this a template function @tag: mebjas, abhinavdahiya
return a + b;
}</pre>
This will Tag user <code>mebjas</code> & <code>abhinavdahiya</code> and notify them.
</section> <!-- tags -->
<section id="deadline">
<div class="page-header">
<h1>Deadline <small>Set deadline on todos, to finish them on time</small></h1>
</div>
<blockquote>
You can set a deadline for a todo, Todofy will track its progress and notify you if a todo crosses it's deadline.
Also you can see all your upcoming deadlines (for todos from different repositories) in the dashboard. Similarly you
can check all your expired todos from the same page. You can set deadline both from dashboard and code.
</blockquote>
<h3> From the dashboard: </h3>
<div class="clearfix"></div>
You can set deadline for a todo from the right hand side menu, click on <code>set deadline</code>
> <code>select a date</code> > <code>click on set</code>.
<div style="margin: 10px">
<img src="./assets/img/deadline.png" alt="labels" style="max-width: 600px">
</div>
<div class="clearfix"></div>
<div class="clearfix"></div>
<h3> Directly in code comment: </h3>
<div class="clearfix"></div>
You can add a deadline using <code>@deadline</code> parameter in your comments. For example in C++:
<div class="clearfix"></div>
<pre>
int getSum(int a, int b) {
// TODO: make this a template function @deadline: 1 week
return a + b;
}</pre>
This will set a deadline of <code>1 week</code> for the todo. In a similar way you can set it as:
<p><code>now</code></p>
<p><code>10 September 2016</code></p>
<p><code>+1 day</code></p>
<p><code>+1 week</code></p>
<p><code>+1 week 2 days 4 hours 2 seconds</code></p>
<p><code>next Thursday</code></p>
<p><code>last Monday</code></p>
<p><code>yyyy-mm-dd</code></p>
<p><code>yy-mm-dd</code>, note in this case if <code>yy</code> is between 00-69 it will be mapped as 2000-2069,
else it will be mapped as 1970-1999.</p>
</section> <!-- deadline -->
<section id="reminder">
<div class="page-header">
<h1>Reminder <small>Set reminder on todos, to make sure you finish them on time</small></h1>
</div>
<blockquote>
You can set reminder for a todo, Todofy will notify you when it's time.
You can set reminder both from dashboard and code.
</blockquote>
<h3> From the dashboard: </h3>
<div class="clearfix"></div>
You can set reminder for a todo from the right hand side menu, click on <code>set reminder</code>
> <code>select a date</code> > <code>click on set</code>.
<div style="margin: 10px">
<img src="./assets/img/reminder.png" alt="labels" style="max-width: 600px">
</div>
<div class="clearfix"></div>
<div class="clearfix"></div>
<h3> Directly in code comment: </h3>
<div class="clearfix"></div>
You can add a reminder using <code>@reminder</code> parameter in your comments. For example in C++:
<div class="clearfix"></div>
<pre>
int getSum(int a, int b) {
// TODO: make this a template function @reminder: 3 day
return a + b;
}</pre>
This will set a deadline of <code>1 week</code> for the todo. In a similar way you can set it as:
<p><code>now</code></p>
<p><code>10 September 2016</code></p>
<p><code>+1 day</code></p>
<p><code>+1 week</code></p>
<p><code>+1 week 2 days 4 hours 2 seconds</code></p>
<p><code>next Thursday</code></p>
<p><code>last Monday</code></p>
<p><code>yyyy-mm-dd</code></p>
<p><code>yy-mm-dd</code>, note in this case if <code>yy</code> is between 00-69 it will be mapped as 2000-2069,
else it will be mapped as 1970-1999.</p>
</section> <!-- reminder -->
<section id="priority">
<div class="page-header">
<h1>Priority <small>Set priority on todos, to organise them!</small></h1>
</div>
<blockquote>
You can set priority for a todo to organise them in the list. It can be added both from dashboard and from
the todo comment.
</blockquote>
<h3> From the dashboard: </h3>
<div class="clearfix"></div>
You can set priority for a todo from the right hand side menu, click on <code>set priority</code>
> <code>select a priority</code>
<div style="margin: 10px">
<img src="./assets/img/priority.png" alt="labels" style="max-width: 600px">
</div>
<div class="clearfix"></div>
<div class="clearfix"></div>
<h3> Directly in code comment: </h3>
<div class="clearfix"></div>
You can set priority using <code>@priority</code> parameter in your comments. For example in C++:
<div class="clearfix"></div>
<pre>
int getSum(int a, int b) {
// TODO: make this a template function @priority: max
return a + b;
}</pre>
<div class="clearfix"></div>
<blockquote>
Note that by default <code>High</code>, <code>Medium</code>, <code>Low</code> priorities are defined in descending order.
If a new priority is added from code, its added to the system and given lowest priority. You can change the order of priority from the <a href="#repo_setting">Repository Settings</a>. Also priority is uniform for all the branches in a repository.
</blockquote>
<div style="margin: 10px">
<img src="./assets/img/priority_change.png" alt="labels" style="max-width: 1000px">
</div>
</section> <!-- priority -->
<section id="gissue">
<div class="page-header">
<h1>Create Github Issue <small>Add a todo as a Github issue</small></h1>
</div>
<blockquote>
You can create a Github issue for any todo. Currently <strong> it's possible only through dashboard. </strong>
But we are working on adding a parameter to auto create a Github issue.
</blockquote>
You can add a Github issue for a todo by clicking on <code>CREATE GITHUB ISSUE</code> button on right hand side.
<div style="margin: 10px">
<img src="./assets/img/issue1.png" alt="labels" style="max-width: 500px">
</div>
<div class="clearfix"></div>
Then fill in the description about this issue.
<div style="margin: 10px">
<img src="./assets/img/issue2.png" alt="labels" style="max-width: 1000px">
</div>
<div class="clearfix"></div>
<blockquote>
<strong>Note</strong> the issue will be created by our bot user <code>fybot</code>. We do not have permissions to auto
create a issue in a public repository with your credentials.
</blockquote>
</section> <!-- Github issue -->
<section id="discussion">
<div class="page-header">
<h1>Discussion <small>Discuss about todos directly using todofy!</small></h1>
</div>
The comment feature can be used by users to discuss about a todo. Currently <strong> it doesn't support HTML or markdown</strong>. We are working on adding <code>Markdown</code> support and options to mention users or cite links.
</section> <!-- discussion -->
<section id="toread">
<div class="page-header">
<h1>To Read <small>Add articles you need to read / look at to finish a todo!</small></h1>
</div>
Collaborators of a repository can add links in <code>to read</code> section, available on right hand side menu.
<strong>Note</strong>: this feature is available only through dashboard. To add a link to this list, click on add
& enter the link and <code>Save</code>. If the link is avialble, it will be added. It can be mark as read by clicking
on the checkbox.
<div style="margin: 10px">
<img src="./assets/img/toread.png" alt="labels" style="max-width: 600px">
</div>
</section> <!-- toread -->
<hr />
<div class="goodbye">
<p>Thank you so much for using todofy!</p>
<blockquote>
Our documentation is open source and hosted at <a href="https://github.com/todofy/documentation">Github</a>. If you find some mistake or think more ifnormation can
be added, kindly fork and send a pull request.
</blockquote>
</div>
<hr />
<footer>
<p>
© Todofy 2015
·
<a href="http://blog.todofy.io">Blog</a>
·
<a href="https://todofy.org/contact">Contact</a>
·
<a href="https://twitter.com/todoci">Twitter</a>
·
<a href="https://github.com/todofy">Github</a>
·
<a href="https://facebook.com/todofy">Facebook</a>
</p>
</footer>
</div><!-- /container -->
<!-- Le javascript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script src="assets/js/jquery.js"></script>
<script src="assets/js/scripts.js"></script>
<script src="assets/js/google-code-prettify/prettify.js"></script>
<script src="assets/js/bootstrap-transition.js"></script>
<script src="assets/js/bootstrap-alert.js"></script>
<script src="assets/js/bootstrap-modal.js"></script>
<script src="assets/js/bootstrap-dropdown.js"></script>
<script src="assets/js/bootstrap-scrollspy.js"></script>
<script src="assets/js/bootstrap-tab.js"></script>
<script src="assets/js/bootstrap-tooltip.js"></script>
<script src="assets/js/bootstrap-popover.js"></script>
<script src="assets/js/bootstrap-button.js"></script>
<script src="assets/js/bootstrap-collapse.js"></script>
<script src="assets/ui/js/ui.js"></script>
<script type="text/javascript">
$(document).ready(function() {
$(".tabbedSpace .tabheader .tab").on('click', function() {
var _for = $(this).attr('for');
$(".tabbedSpace .tabheader .tab").removeClass('selected');
$(this).addClass('selected');
$(".tabbedSpace .tabBody .tab").removeClass('selected');
$(".tabbedSpace .tabBody .tab[for='" +_for +"']").addClass('selected');
});
})
</script>
</body>
</html>