-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME.html
More file actions
684 lines (595 loc) · 25.9 KB
/
README.html
File metadata and controls
684 lines (595 loc) · 25.9 KB
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
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><title>Untitled</title><style>
/* cspell:disable-file */
/* webkit printing magic: print all background colors */
html {
-webkit-print-color-adjust: exact;
}
* {
box-sizing: border-box;
-webkit-print-color-adjust: exact;
}
html,
body {
margin: 0;
padding: 0;
}
@media only screen {
body {
margin: 2em auto;
max-width: 900px;
color: rgb(55, 53, 47);
}
}
body {
line-height: 1.5;
white-space: pre-wrap;
}
a,
a.visited {
color: inherit;
text-decoration: underline;
}
.pdf-relative-link-path {
font-size: 80%;
color: #444;
}
h1,
h2,
h3 {
letter-spacing: -0.01em;
line-height: 1.2;
font-weight: 600;
margin-bottom: 0;
}
.page-title {
font-size: 2.5rem;
font-weight: 700;
margin-top: 0;
margin-bottom: 0.75em;
}
h1 {
font-size: 1.875rem;
margin-top: 1.875rem;
}
h2 {
font-size: 1.5rem;
margin-top: 1.5rem;
}
h3 {
font-size: 1.25rem;
margin-top: 1.25rem;
}
.source {
border: 1px solid #ddd;
border-radius: 3px;
padding: 1.5em;
word-break: break-all;
}
.callout {
border-radius: 3px;
padding: 1rem;
}
figure {
margin: 1.25em 0;
page-break-inside: avoid;
}
figcaption {
opacity: 0.5;
font-size: 85%;
margin-top: 0.5em;
}
mark {
background-color: transparent;
}
.indented {
padding-left: 1.5em;
}
hr {
background: transparent;
display: block;
width: 100%;
height: 1px;
visibility: visible;
border: none;
border-bottom: 1px solid rgba(55, 53, 47, 0.09);
}
img {
max-width: 100%;
}
@media only print {
img {
max-height: 100vh;
object-fit: contain;
}
}
@page {
margin: 1in;
}
.collection-content {
font-size: 0.875rem;
}
.column-list {
display: flex;
justify-content: space-between;
}
.column {
padding: 0 1em;
}
.column:first-child {
padding-left: 0;
}
.column:last-child {
padding-right: 0;
}
.table_of_contents-item {
display: block;
font-size: 0.875rem;
line-height: 1.3;
padding: 0.125rem;
}
.table_of_contents-indent-1 {
margin-left: 1.5rem;
}
.table_of_contents-indent-2 {
margin-left: 3rem;
}
.table_of_contents-indent-3 {
margin-left: 4.5rem;
}
.table_of_contents-link {
text-decoration: none;
opacity: 0.7;
border-bottom: 1px solid rgba(55, 53, 47, 0.18);
}
table,
th,
td {
border: 1px solid rgba(55, 53, 47, 0.09);
border-collapse: collapse;
}
table {
border-left: none;
border-right: none;
}
th,
td {
font-weight: normal;
padding: 0.25em 0.5em;
line-height: 1.5;
min-height: 1.5em;
text-align: left;
}
th {
color: rgba(55, 53, 47, 0.6);
}
ol,
ul {
margin: 0;
margin-block-start: 0.6em;
margin-block-end: 0.6em;
}
li > ol:first-child,
li > ul:first-child {
margin-block-start: 0.6em;
}
ul > li {
list-style: disc;
}
ul.to-do-list {
padding-inline-start: 0;
}
ul.to-do-list > li {
list-style: none;
}
.to-do-children-checked {
text-decoration: line-through;
opacity: 0.375;
}
ul.toggle > li {
list-style: none;
}
ul {
padding-inline-start: 1.7em;
}
ul > li {
padding-left: 0.1em;
}
ol {
padding-inline-start: 1.6em;
}
ol > li {
padding-left: 0.2em;
}
.mono ol {
padding-inline-start: 2em;
}
.mono ol > li {
text-indent: -0.4em;
}
.toggle {
padding-inline-start: 0em;
list-style-type: none;
}
/* Indent toggle children */
.toggle > li > details {
padding-left: 1.7em;
}
.toggle > li > details > summary {
margin-left: -1.1em;
}
.selected-value {
display: inline-block;
padding: 0 0.5em;
background: rgba(206, 205, 202, 0.5);
border-radius: 3px;
margin-right: 0.5em;
margin-top: 0.3em;
margin-bottom: 0.3em;
white-space: nowrap;
}
.collection-title {
display: inline-block;
margin-right: 1em;
}
.page-description {
margin-bottom: 2em;
}
.simple-table {
margin-top: 1em;
font-size: 0.875rem;
empty-cells: show;
}
.simple-table td {
height: 29px;
min-width: 120px;
}
.simple-table th {
height: 29px;
min-width: 120px;
}
.simple-table-header-color {
background: rgb(247, 246, 243);
color: black;
}
.simple-table-header {
font-weight: 500;
}
time {
opacity: 0.5;
}
.icon {
display: inline-block;
max-width: 1.2em;
max-height: 1.2em;
text-decoration: none;
vertical-align: text-bottom;
margin-right: 0.5em;
}
img.icon {
border-radius: 3px;
}
.user-icon {
width: 1.5em;
height: 1.5em;
border-radius: 100%;
margin-right: 0.5rem;
}
.user-icon-inner {
font-size: 0.8em;
}
.text-icon {
border: 1px solid #000;
text-align: center;
}
.page-cover-image {
display: block;
object-fit: cover;
width: 100%;
max-height: 30vh;
}
.page-header-icon {
font-size: 3rem;
margin-bottom: 1rem;
}
.page-header-icon-with-cover {
margin-top: -0.72em;
margin-left: 0.07em;
}
.page-header-icon img {
border-radius: 3px;
}
.link-to-page {
margin: 1em 0;
padding: 0;
border: none;
font-weight: 500;
}
p > .user {
opacity: 0.5;
}
td > .user,
td > time {
white-space: nowrap;
}
input[type="checkbox"] {
transform: scale(1.5);
margin-right: 0.6em;
vertical-align: middle;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
.image {
border: none;
margin: 1.5em 0;
padding: 0;
border-radius: 0;
text-align: center;
}
.code,
code {
background: rgba(135, 131, 120, 0.15);
border-radius: 3px;
padding: 0.2em 0.4em;
border-radius: 3px;
font-size: 85%;
tab-size: 2;
}
code {
color: #eb5757;
}
.code {
padding: 1.5em 1em;
}
.code-wrap {
white-space: pre-wrap;
word-break: break-all;
}
.code > code {
background: none;
padding: 0;
font-size: 100%;
color: inherit;
}
blockquote {
font-size: 1.25em;
margin: 1em 0;
padding-left: 1em;
border-left: 3px solid rgb(55, 53, 47);
}
.bookmark {
text-decoration: none;
max-height: 8em;
padding: 0;
display: flex;
width: 100%;
align-items: stretch;
}
.bookmark-title {
font-size: 0.85em;
overflow: hidden;
text-overflow: ellipsis;
height: 1.75em;
white-space: nowrap;
}
.bookmark-text {
display: flex;
flex-direction: column;
}
.bookmark-info {
flex: 4 1 180px;
padding: 12px 14px 14px;
display: flex;
flex-direction: column;
justify-content: space-between;
}
.bookmark-image {
width: 33%;
flex: 1 1 180px;
display: block;
position: relative;
object-fit: cover;
border-radius: 1px;
}
.bookmark-description {
color: rgba(55, 53, 47, 0.6);
font-size: 0.75em;
overflow: hidden;
max-height: 4.5em;
word-break: break-word;
}
.bookmark-href {
font-size: 0.75em;
margin-top: 0.25em;
}
.sans { font-family: ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI Variable Display", "Segoe UI", Helvetica, "Apple Color Emoji", Arial, sans-serif, "Segoe UI Emoji", "Segoe UI Symbol"; }
.code { font-family: "SFMono-Regular", Menlo, Consolas, "PT Mono", "Liberation Mono", Courier, monospace; }
.serif { font-family: Lyon-Text, Georgia, ui-serif, serif; }
.mono { font-family: iawriter-mono, Nitti, Menlo, Courier, monospace; }
.pdf .sans { font-family: Inter, ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI Variable Display", "Segoe UI", Helvetica, "Apple Color Emoji", Arial, sans-serif, "Segoe UI Emoji", "Segoe UI Symbol", 'Twemoji', 'Noto Color Emoji', 'Noto Sans CJK JP'; }
.pdf:lang(zh-CN) .sans { font-family: Inter, ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI Variable Display", "Segoe UI", Helvetica, "Apple Color Emoji", Arial, sans-serif, "Segoe UI Emoji", "Segoe UI Symbol", 'Twemoji', 'Noto Color Emoji', 'Noto Sans CJK SC'; }
.pdf:lang(zh-TW) .sans { font-family: Inter, ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI Variable Display", "Segoe UI", Helvetica, "Apple Color Emoji", Arial, sans-serif, "Segoe UI Emoji", "Segoe UI Symbol", 'Twemoji', 'Noto Color Emoji', 'Noto Sans CJK TC'; }
.pdf:lang(ko-KR) .sans { font-family: Inter, ui-sans-serif, -apple-system, BlinkMacSystemFont, "Segoe UI Variable Display", "Segoe UI", Helvetica, "Apple Color Emoji", Arial, sans-serif, "Segoe UI Emoji", "Segoe UI Symbol", 'Twemoji', 'Noto Color Emoji', 'Noto Sans CJK KR'; }
.pdf .code { font-family: Source Code Pro, "SFMono-Regular", Menlo, Consolas, "PT Mono", "Liberation Mono", Courier, monospace, 'Twemoji', 'Noto Color Emoji', 'Noto Sans Mono CJK JP'; }
.pdf:lang(zh-CN) .code { font-family: Source Code Pro, "SFMono-Regular", Menlo, Consolas, "PT Mono", "Liberation Mono", Courier, monospace, 'Twemoji', 'Noto Color Emoji', 'Noto Sans Mono CJK SC'; }
.pdf:lang(zh-TW) .code { font-family: Source Code Pro, "SFMono-Regular", Menlo, Consolas, "PT Mono", "Liberation Mono", Courier, monospace, 'Twemoji', 'Noto Color Emoji', 'Noto Sans Mono CJK TC'; }
.pdf:lang(ko-KR) .code { font-family: Source Code Pro, "SFMono-Regular", Menlo, Consolas, "PT Mono", "Liberation Mono", Courier, monospace, 'Twemoji', 'Noto Color Emoji', 'Noto Sans Mono CJK KR'; }
.pdf .serif { font-family: PT Serif, Lyon-Text, Georgia, ui-serif, serif, 'Twemoji', 'Noto Color Emoji', 'Noto Serif CJK JP'; }
.pdf:lang(zh-CN) .serif { font-family: PT Serif, Lyon-Text, Georgia, ui-serif, serif, 'Twemoji', 'Noto Color Emoji', 'Noto Serif CJK SC'; }
.pdf:lang(zh-TW) .serif { font-family: PT Serif, Lyon-Text, Georgia, ui-serif, serif, 'Twemoji', 'Noto Color Emoji', 'Noto Serif CJK TC'; }
.pdf:lang(ko-KR) .serif { font-family: PT Serif, Lyon-Text, Georgia, ui-serif, serif, 'Twemoji', 'Noto Color Emoji', 'Noto Serif CJK KR'; }
.pdf .mono { font-family: PT Mono, iawriter-mono, Nitti, Menlo, Courier, monospace, 'Twemoji', 'Noto Color Emoji', 'Noto Sans Mono CJK JP'; }
.pdf:lang(zh-CN) .mono { font-family: PT Mono, iawriter-mono, Nitti, Menlo, Courier, monospace, 'Twemoji', 'Noto Color Emoji', 'Noto Sans Mono CJK SC'; }
.pdf:lang(zh-TW) .mono { font-family: PT Mono, iawriter-mono, Nitti, Menlo, Courier, monospace, 'Twemoji', 'Noto Color Emoji', 'Noto Sans Mono CJK TC'; }
.pdf:lang(ko-KR) .mono { font-family: PT Mono, iawriter-mono, Nitti, Menlo, Courier, monospace, 'Twemoji', 'Noto Color Emoji', 'Noto Sans Mono CJK KR'; }
.highlight-default {
color: rgba(55, 53, 47, 1);
}
.highlight-gray {
color: rgba(120, 119, 116, 1);
fill: rgba(120, 119, 116, 1);
}
.highlight-brown {
color: rgba(159, 107, 83, 1);
fill: rgba(159, 107, 83, 1);
}
.highlight-orange {
color: rgba(217, 115, 13, 1);
fill: rgba(217, 115, 13, 1);
}
.highlight-yellow {
color: rgba(203, 145, 47, 1);
fill: rgba(203, 145, 47, 1);
}
.highlight-teal {
color: rgba(68, 131, 97, 1);
fill: rgba(68, 131, 97, 1);
}
.highlight-blue {
color: rgba(51, 126, 169, 1);
fill: rgba(51, 126, 169, 1);
}
.highlight-purple {
color: rgba(144, 101, 176, 1);
fill: rgba(144, 101, 176, 1);
}
.highlight-pink {
color: rgba(193, 76, 138, 1);
fill: rgba(193, 76, 138, 1);
}
.highlight-red {
color: rgba(212, 76, 71, 1);
fill: rgba(212, 76, 71, 1);
}
.highlight-default_background {
color: rgba(55, 53, 47, 1);
}
.highlight-gray_background {
background: rgba(248, 248, 247, 1);
}
.highlight-brown_background {
background: rgba(244, 238, 238, 1);
}
.highlight-orange_background {
background: rgba(251, 236, 221, 1);
}
.highlight-yellow_background {
background: rgba(251, 243, 219, 1);
}
.highlight-teal_background {
background: rgba(237, 243, 236, 1);
}
.highlight-blue_background {
background: rgba(231, 243, 248, 1);
}
.highlight-purple_background {
background: rgba(248, 243, 252, 1);
}
.highlight-pink_background {
background: rgba(252, 241, 246, 1);
}
.highlight-red_background {
background: rgba(253, 235, 236, 1);
}
.block-color-default {
color: inherit;
fill: inherit;
}
.block-color-gray {
color: rgba(120, 119, 116, 1);
fill: rgba(120, 119, 116, 1);
}
.block-color-brown {
color: rgba(159, 107, 83, 1);
fill: rgba(159, 107, 83, 1);
}
.block-color-orange {
color: rgba(217, 115, 13, 1);
fill: rgba(217, 115, 13, 1);
}
.block-color-yellow {
color: rgba(203, 145, 47, 1);
fill: rgba(203, 145, 47, 1);
}
.block-color-teal {
color: rgba(68, 131, 97, 1);
fill: rgba(68, 131, 97, 1);
}
.block-color-blue {
color: rgba(51, 126, 169, 1);
fill: rgba(51, 126, 169, 1);
}
.block-color-purple {
color: rgba(144, 101, 176, 1);
fill: rgba(144, 101, 176, 1);
}
.block-color-pink {
color: rgba(193, 76, 138, 1);
fill: rgba(193, 76, 138, 1);
}
.block-color-red {
color: rgba(212, 76, 71, 1);
fill: rgba(212, 76, 71, 1);
}
.block-color-default_background {
color: inherit;
fill: inherit;
}
.block-color-gray_background {
background: rgba(248, 248, 247, 1);
}
.block-color-brown_background {
background: rgba(244, 238, 238, 1);
}
.block-color-orange_background {
background: rgba(251, 236, 221, 1);
}
.block-color-yellow_background {
background: rgba(251, 243, 219, 1);
}
.block-color-teal_background {
background: rgba(237, 243, 236, 1);
}
.block-color-blue_background {
background: rgba(231, 243, 248, 1);
}
.block-color-purple_background {
background: rgba(248, 243, 252, 1);
}
.block-color-pink_background {
background: rgba(252, 241, 246, 1);
}
.block-color-red_background {
background: rgba(253, 235, 236, 1);
}
.select-value-color-uiBlue { background-color: undefined; }
.select-value-color-pink { background-color: rgba(225, 136, 179, 0.27); }
.select-value-color-purple { background-color: rgba(168, 129, 197, 0.27); }
.select-value-color-green { background-color: rgba(123, 183, 129, 0.27); }
.select-value-color-gray { background-color: rgba(84, 72, 49, 0.15); }
.select-value-color-transparentGray { background-color: undefined; }
.select-value-color-translucentGray { background-color: undefined; }
.select-value-color-orange { background-color: rgba(224, 124, 57, 0.27); }
.select-value-color-brown { background-color: rgba(210, 162, 141, 0.35); }
.select-value-color-red { background-color: rgba(244, 171, 159, 0.4); }
.select-value-color-yellow { background-color: rgba(236, 191, 66, 0.39); }
.select-value-color-blue { background-color: rgba(93, 165, 206, 0.27); }
.select-value-color-pageGlass { background-color: undefined; }
.select-value-color-washGlass { background-color: undefined; }
.checkbox {
display: inline-flex;
vertical-align: text-bottom;
width: 16;
height: 16;
background-size: 16px;
margin-left: 2px;
margin-right: 5px;
}
.checkbox-on {
background-image: url("data:image/svg+xml;charset=UTF-8,%3Csvg%20width%3D%2216%22%20height%3D%2216%22%20viewBox%3D%220%200%2016%2016%22%20fill%3D%22none%22%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%3E%0A%3Crect%20width%3D%2216%22%20height%3D%2216%22%20fill%3D%22%2358A9D7%22%2F%3E%0A%3Cpath%20d%3D%22M6.71429%2012.2852L14%204.9995L12.7143%203.71436L6.71429%209.71378L3.28571%206.2831L2%207.57092L6.71429%2012.2852Z%22%20fill%3D%22white%22%2F%3E%0A%3C%2Fsvg%3E");
}
.checkbox-off {
background-image: url("data:image/svg+xml;charset=UTF-8,%3Csvg%20width%3D%2216%22%20height%3D%2216%22%20viewBox%3D%220%200%2016%2016%22%20fill%3D%22none%22%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%3E%0A%3Crect%20x%3D%220.75%22%20y%3D%220.75%22%20width%3D%2214.5%22%20height%3D%2214.5%22%20fill%3D%22white%22%20stroke%3D%22%2336352F%22%20stroke-width%3D%221.5%22%2F%3E%0A%3C%2Fsvg%3E");
}
</style></head><body><article id="1bb2aaa5-4f52-806d-82fa-f7bcad7b4c3a" class="page sans"><header><h1 class="page-title"></h1><p class="page-description"></p></header><div class="page-body"><h1 id="1c12aaa5-4f52-8038-be7b-cfa5cb784dd3" class="">the Dook's archive</h1><p id="1c12aaa5-4f52-8096-baf6-fe91cf9eba9d" class="">The Dook's Archive is a comprehensive repository for automated documentation, open-source resources, and technical guides, leveraging AI and modern tools to streamline the process of creating and managing documents efficiently." 🚀📜</p><h2 id="1c12aaa5-4f52-80ac-b479-c698c3b881a7" class="">My First Personal Experience in Open Source with Search and AI Power</h2><p id="1c12aaa5-4f52-804e-8cae-d299702540e6" class="">When I started exploring the open-source world, I realized that searching itself is a valuable skill. With the advancements in AI, we can now achieve results faster and more accurately. As I set up this repository, my goal is to bring together the best documentation and repo ever.</p><blockquote id="1c12aaa5-4f52-806f-bf14-cdf3053e766c" class="">Fun Challenge: There might be a tiny intentional bug hidden in here. If you find it, I’d love to have you onboard as a contributor! 😉</blockquote><hr id="1c12aaa5-4f52-8018-b506-e6df9e4bff5e"/><h2 id="1c12aaa5-4f52-8000-a73f-e4b88c964288" class="">Why Writing Good Documentation is Essential</h2><p id="1c12aaa5-4f52-803b-9711-ce5927d3b2af" class="">Good documentation is a key component of any project, especially for open-source software. It helps developers, contributors, and users understand, use, and improve a project efficiently. A well-documented project:</p><ul id="1c12aaa5-4f52-80ca-a083-fd2f055ffeb4" class="bulleted-list"><li style="list-style-type:disc"><strong>Increases adoption and usability</strong></li></ul><ul id="1c12aaa5-4f52-802f-850e-e59773c071f8" class="bulleted-list"><li style="list-style-type:disc"><strong>Enhances collaboration</strong></li></ul><ul id="1c12aaa5-4f52-8051-be28-f37c04160c21" class="bulleted-list"><li style="list-style-type:disc"><strong>Saves time for maintainers and contributors</strong></li></ul><ul id="1c12aaa5-4f52-80ea-8e31-fce885ed8dd2" class="bulleted-list"><li style="list-style-type:disc"><strong>Improves onboarding for new developers</strong></li></ul><p id="1c12aaa5-4f52-808f-a681-edafdc79cfba" class="">🔗 <a href="https://github.com/pengqun/awesome-documentation">How to Write Great Documentation</a> – A curated list of best practices for writing effective documentation.</p><h3 id="1c12aaa5-4f52-8044-b6be-d72fb3ff4212" class="">How to Write Good Documentation (For Beginners)</h3><ol type="1" id="1c12aaa5-4f52-8047-a62c-cdf0389c0e5e" class="numbered-list" start="1"><li><strong>Know Your Audience</strong><p id="1c12aaa5-4f52-8071-9be6-f688d715d64f" class="">Tailor your documentation for users, contributors, and developers.</p></li></ol><ol type="1" id="1c12aaa5-4f52-8091-bd75-f76c38874374" class="numbered-list" start="2"><li><strong>Structure It Well</strong><p id="1c12aaa5-4f52-808e-a780-c51ae61a3ef3" class="">A good documentation structure includes:</p><ul id="1c12aaa5-4f52-8087-9dce-d2d12a053a4a" class="bulleted-list"><li style="list-style-type:disc"><strong>Introduction</strong>: What is the project about?</li></ul><ul id="1c12aaa5-4f52-800c-af64-ebdf190748f0" class="bulleted-list"><li style="list-style-type:disc"><strong>Installation</strong>: How to install it?</li></ul><ul id="1c12aaa5-4f52-8043-aca5-dbd7e9459263" class="bulleted-list"><li style="list-style-type:disc"><strong>Usage</strong>: How to use it?</li></ul><ul id="1c12aaa5-4f52-8011-b211-c381b9e542c8" class="bulleted-list"><li style="list-style-type:disc"><strong>API Reference</strong>: For developers</li></ul><ul id="1c12aaa5-4f52-80be-8e72-dff2bda4550f" class="bulleted-list"><li style="list-style-type:disc"><strong>Contribution Guide</strong>: How others can contribute</li></ul><ul id="1c12aaa5-4f52-80ab-b027-e44c8825cd83" class="bulleted-list"><li style="list-style-type:disc"><strong>FAQ & Troubleshooting</strong>: Common issues & fixes</li></ul></li></ol><ol type="1" id="1c12aaa5-4f52-80ae-96f3-fb45b7c22535" class="numbered-list" start="3"><li><strong>Keep It Simple & Clear</strong><p id="1c12aaa5-4f52-80dd-9b34-fa8fd2cf7285" class="">Use simple language, avoid jargon, and add code examples.</p></li></ol><ol type="1" id="1c12aaa5-4f52-802c-9da4-d2e55e9ce682" class="numbered-list" start="4"><li><strong>Use Proper Formatting</strong><p id="1c12aaa5-4f52-8098-8288-cf8499148a57" class="">Markdown is the standard for GitHub documentation.</p></li></ol><ol type="1" id="1c12aaa5-4f52-80f8-b326-cfe7edc659b4" class="numbered-list" start="5"><li><strong>Add Visuals</strong><p id="1c12aaa5-4f52-8089-bdab-d18175d481e4" class="">Diagrams, GIFs, and screenshots improve understanding.</p></li></ol><p id="1c12aaa5-4f52-807c-845b-e3e7c90fe288" class="">🔗 <a href="https://github.com/matiassingers/awesome-readme">Beginner’s Guide to Documentation</a> – A great starting point if you're new to documentation.</p><h2 id="1c12aaa5-4f52-80ad-96a9-ff8355796328" class="">Best Documentation Examples</h2><p id="1c12aaa5-4f52-802b-b674-ff4ddb751611" class="">Some projects stand out due to well-structured and visually appealing documentation. If you need inspiration, check these:</p><p id="1c12aaa5-4f52-8035-afda-f5e01327cdc5" class="">🔗 <a href="https://github.com/PharkMillups/beautiful-docs">Beautiful Docs</a> 🌟 – A collection of great documentation examples.</p><hr id="1c12aaa5-4f52-80e6-b654-e82e3a526379"/><h2 id="1c12aaa5-4f52-80a7-ba39-f5dbe575554a" class="">Why Documentation Matters in Open Source</h2><p id="1c12aaa5-4f52-80b9-acf1-ed527f8eda3a" class="">Many open-source projects fail due to poor documentation. Even the best code is useless if people don’t know how to use or contribute to it. Documentation bridges the gap between code and usability, making projects more accessible and encouraging collaboration.</p><p id="1c12aaa5-4f52-806c-8b43-e17740031e85" class="">📌 <strong>Without Documentation:</strong></p><ul id="1c12aaa5-4f52-8099-b0af-f2d04ede5ca9" class="bulleted-list"><li style="list-style-type:disc">❌ Users don’t know how to use the project.</li></ul><ul id="1c12aaa5-4f52-80d8-86cf-ebc9ec6ebbf5" class="bulleted-list"><li style="list-style-type:disc">❌ New contributors struggle to participate.</li></ul><ul id="1c12aaa5-4f52-801d-9b3e-f198d66094a9" class="bulleted-list"><li style="list-style-type:disc">❌ Debugging and issue resolution take longer.</li></ul><p id="1c12aaa5-4f52-80e1-8104-f1f9784b6a46" class="">💡 <strong>Why Should You Care?</strong></p><ul id="1c12aaa5-4f52-804a-8bea-fec98e9f68fd" class="bulleted-list"><li style="list-style-type:disc">Contributors need clear guides to collaborate effectively.</li></ul><ul id="1c12aaa5-4f52-80c4-9646-fa240e5e2e22" class="bulleted-list"><li style="list-style-type:disc">Beginners rely on documentation to learn and get involved.</li></ul><ul id="1c12aaa5-4f52-80c0-8e1e-c3f36a93db81" class="bulleted-list"><li style="list-style-type:disc">Maintainers can grow their projects faster with good documentation.</li></ul><p id="1c12aaa5-4f52-8018-8601-f7a09a759584" class="">🔗 <a href="https://github.com/resources/articles/software-development/what-is-open-source-software">Open Source Documentation Resources</a> – Learn how to write effective documentation for open-source projects.</p><hr id="1c12aaa5-4f52-802a-b672-e86339705fe6"/><h2 id="1c12aaa5-4f52-8010-aa6d-cb4abfa7912a" class="">The Open Source Philosophy and Its Connection to Documentation</h2><p id="1c12aaa5-4f52-8021-8ac9-de02d9e07970" class="">The open-source philosophy is about making knowledge accessible. But open code alone isn’t enough—it must be understandable. Documentation is what makes open source truly open, allowing users and contributors to learn, adapt, and improve software.</p><p id="1c12aaa5-4f52-808d-a329-e54e5f6ae1bc" class="">🔗 <a href="https://opensource.org/osd">The Open Source Definition</a> – The principles of open source.</p><p id="1c12aaa5-4f52-809c-a11e-e41b8cb4b7c6" class="">📌 <strong>Key Connection:</strong> Open source thrives on collaboration and knowledge sharing—and documentation is the key that makes it possible.</p><hr id="1c12aaa5-4f52-8000-a78b-dd6d2bdb5492"/><h2 id="1c12aaa5-4f52-80b4-adc0-c101796414dd" class="">The Best Open-Source Repositories for Documentation</h2><p id="1c12aaa5-4f52-80ea-a941-ee3a312029c8" class="">Good documentation isn’t just about writing—it’s about learning from the best. Here are some top open-source repositories known for their excellent documentation:</p><p id="1c12aaa5-4f52-8016-9424-ed98b257f92e" class="">🔗 <a href="https://github.com/cornelius/awesome-open-source">Awesome Open Source Projects</a> – A collection of high-quality, well-documented open-source projects.</p><p id="1c12aaa5-4f52-807c-baa7-fc229e873fcf" class="">🔗 <a href="https://github.com/MunGell/awesome-for-beginners">Open Source Projects for Beginners</a> – Beginner-friendly projects with clear documentation.</p><p id="1c12aaa5-4f52-8063-af64-de71a317dc7e" class="">🔗 <a href="https://github.com/exajobs/opensource-collection">Curated List of Open Source Repositories</a> – A well-maintained list of open-source repositories for learning and contributing.</p><p id="1c12aaa5-4f52-80db-85f6-f66165600fdc" class="">📌 <strong>Takeaway:</strong> Studying these repositories can help improve your own documentation skills!</p><hr id="1c12aaa5-4f52-80c6-b0eb-d0c39282de58"/><h2 id="1c12aaa5-4f52-8042-8714-f576945cbefa" class="">Top Resources for Improving Documentation Skills</h2><p id="1c12aaa5-4f52-80ef-ad08-ce3c98e7113f" class="">Enhance your documentation skills with these guides, courses, and video content:</p><p id="1c12aaa5-4f52-80d2-b8e7-f27761b821d6" class="">🔗 <a href="https://github.com/EbookFoundation/free-programming-books">List of Free Learning Resources</a> – Free programming books in multiple languages.</p><p id="1c12aaa5-4f52-8010-bc91-f5a7384f9dce" class="">🔗 <a href="https://github.com/ErikCH/DevYouTubeList">YouTube Channels for Developers</a> – Top YouTube channels covering coding, documentation, and tech tutorials.</p><p id="1c12aaa5-4f52-80a4-8153-ed67048327fa" class="">🔗 <a href="https://github.com/TranBaVinhSon/awesome-programming-tutorials">Awesome Programming Tutorials</a> – Useful tutorials on documentation best practices.</p><p id="1c12aaa5-4f52-80fe-83c5-f10916406ab5" class="">🔗 <a href="https://github.com/lucasviola/awesome-tech-videos">Awesome Tech Videos</a> – A collection of educational tech videos.</p><hr id="1c12aaa5-4f52-80db-a34f-ca99a4507d56"/><h2 id="1c12aaa5-4f52-80d1-aa06-c835a5f74f2e" class="">📌 To-Do List</h2><ul id="1c12aaa5-4f52-80ae-99b7-faed387b0bae" class="to-do-list"><li><div class="checkbox checkbox-off"></div> <span class="to-do-children-unchecked"><strong>Automation:</strong> Implement an automation system for updating and maintaining documentation.</span><div class="indented"></div></li></ul><ul id="1c12aaa5-4f52-80c1-b8ee-c7766be589af" class="to-do-list"><li><div class="checkbox checkbox-off"></div> <span class="to-do-children-unchecked"><strong>Persian Language Support:</strong> Add Persian-language lists and translations for existing documents.</span><div class="indented"></div></li></ul><hr id="1c12aaa5-4f52-80e7-8432-f94e42c94252"/></div></article><span class="sans" style="font-size:14px;padding-top:2em"></span></body></html>