-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSTARTUP_GUIDE.html
More file actions
1779 lines (1582 loc) · 67.3 KB
/
STARTUP_GUIDE.html
File metadata and controls
1779 lines (1582 loc) · 67.3 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
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Sentinel User Guide</title>
<style>
*, *::before, *::after { box-sizing: border-box; margin: 0; padding: 0; }
:root {
--bg: #f8fafc;
--surface: #ffffff;
--text: #1e293b;
--text-muted: #64748b;
--primary: #0e7490;
--primary-light: #e0f2fe;
--primary-hover: #0c6577;
--accent: #0284c7;
--border: #e2e8f0;
--code-bg: #f1f5f9;
--success: #16a34a;
--warning: #d97706;
--danger: #dc2626;
--radius: 8px;
--shadow: 0 1px 3px rgba(0,0,0,0.08), 0 1px 2px rgba(0,0,0,0.04);
--shadow-md: 0 4px 6px rgba(0,0,0,0.07), 0 2px 4px rgba(0,0,0,0.04);
--nav-w: 280px;
--highlight: #fef08a;
}
@media (prefers-color-scheme: dark) {
:root {
--bg: #0f172a;
--surface: #1e293b;
--text: #e2e8f0;
--text-muted: #94a3b8;
--primary: #22d3ee;
--primary-light: #164e63;
--primary-hover: #06b6d4;
--accent: #38bdf8;
--border: #334155;
--code-bg: #0f172a;
--success: #4ade80;
--warning: #fbbf24;
--danger: #f87171;
--highlight: #854d0e;
}
}
html { scroll-behavior: smooth; }
body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif;
background: var(--bg);
color: var(--text);
line-height: 1.7;
font-size: 16px;
}
/* ============ SIDEBAR NAV ============ */
nav {
position: fixed;
top: 0;
left: 0;
width: var(--nav-w);
height: 100vh;
background: var(--surface);
border-right: 1px solid var(--border);
display: flex;
flex-direction: column;
z-index: 100;
}
.nav-header {
padding: 20px 16px 0;
flex-shrink: 0;
}
.brand {
display: flex;
align-items: center;
gap: 10px;
padding-bottom: 16px;
border-bottom: 1px solid var(--border);
margin-bottom: 12px;
}
.brand .logo {
width: 32px;
height: 32px;
border-radius: 6px;
object-fit: contain;
}
.brand span {
font-weight: 700;
font-size: 17px;
color: var(--text);
}
/* ---- SEARCH ---- */
.search-wrap {
position: relative;
margin-bottom: 12px;
}
.search-wrap svg {
position: absolute;
left: 10px;
top: 50%;
transform: translateY(-50%);
width: 15px;
height: 15px;
color: var(--text-muted);
pointer-events: none;
}
#search {
width: 100%;
padding: 8px 32px 8px 32px;
border: 1px solid var(--border);
border-radius: 6px;
background: var(--bg);
color: var(--text);
font-size: 13px;
outline: none;
transition: border-color 0.15s;
}
#search:focus { border-color: var(--primary); }
#search-clear {
position: absolute;
right: 6px;
top: 50%;
transform: translateY(-50%);
width: 20px;
height: 20px;
border: none;
background: none;
color: var(--text-muted);
cursor: pointer;
font-size: 16px;
line-height: 1;
display: none;
padding: 0;
}
#search-clear:hover { color: var(--text); }
#search.has-value ~ #search-clear { display: block; }
.search-info {
font-size: 11px;
color: var(--text-muted);
padding: 4px 0 8px;
display: none;
}
.search-info.visible { display: block; }
/* ---- NAV TOC ---- */
.nav-toc {
flex: 1;
overflow-y: auto;
padding: 0 0 20px;
}
.nav-toc::-webkit-scrollbar { width: 4px; }
.nav-toc::-webkit-scrollbar-thumb { background: var(--border); border-radius: 4px; }
.chapter-group { margin-bottom: 2px; }
.chapter-toggle {
display: flex;
align-items: center;
gap: 8px;
width: 100%;
padding: 8px 16px;
border: none;
background: none;
color: var(--text);
font-size: 13px;
font-weight: 600;
cursor: pointer;
text-align: left;
transition: background 0.1s;
}
.chapter-toggle:hover { background: var(--primary-light); }
.chapter-toggle .ch-num {
display: inline-flex;
align-items: center;
justify-content: center;
width: 22px;
height: 22px;
border-radius: 5px;
background: var(--primary);
color: #fff;
font-size: 11px;
font-weight: 700;
flex-shrink: 0;
}
.chapter-toggle .ch-arrow {
margin-left: auto;
font-size: 10px;
color: var(--text-muted);
transition: transform 0.2s;
}
.chapter-group.open .ch-arrow { transform: rotate(90deg); }
.chapter-sections {
display: none;
padding: 0 0 6px;
}
.chapter-group.open .chapter-sections { display: block; }
.chapter-sections a {
display: block;
padding: 4px 16px 4px 46px;
color: var(--text-muted);
text-decoration: none;
font-size: 13px;
transition: color 0.1s, background 0.1s;
border-left: 3px solid transparent;
}
.chapter-sections a:hover,
.chapter-sections a.active {
color: var(--primary);
background: var(--primary-light);
border-left-color: var(--primary);
}
.nav-toc .no-results {
padding: 20px 16px;
font-size: 13px;
color: var(--text-muted);
text-align: center;
display: none;
}
/* ============ MOBILE NAV TOGGLE ============ */
.nav-toggle {
display: none;
position: fixed;
top: 12px;
left: 12px;
z-index: 200;
width: 40px;
height: 40px;
border-radius: 8px;
border: 1px solid var(--border);
background: var(--surface);
color: var(--text);
cursor: pointer;
font-size: 20px;
align-items: center;
justify-content: center;
box-shadow: var(--shadow);
}
.nav-overlay {
display: none;
position: fixed;
inset: 0;
background: rgba(0,0,0,0.4);
z-index: 90;
}
/* ============ MAIN ============ */
main {
margin-left: var(--nav-w);
max-width: 840px;
padding: 48px 48px 96px;
}
/* ---- HERO ---- */
.hero {
text-align: center;
padding: 40px 0 36px;
border-bottom: 1px solid var(--border);
margin-bottom: 48px;
}
.hero-icon {
width: 88px;
height: 88px;
object-fit: contain;
margin-bottom: 12px;
}
.hero h1 {
font-size: 2.2rem;
font-weight: 800;
letter-spacing: -0.025em;
margin-bottom: 10px;
}
.hero .subtitle {
font-size: 1.1rem;
color: var(--text-muted);
max-width: 540px;
margin: 0 auto 16px;
}
.badge-row {
display: flex;
justify-content: center;
gap: 8px;
flex-wrap: wrap;
}
.badge {
display: inline-block;
padding: 4px 12px;
border-radius: 999px;
font-size: 12px;
font-weight: 600;
background: var(--primary-light);
color: var(--primary);
}
/* ---- CHAPTER HEADERS ---- */
.chapter-header {
display: flex;
align-items: center;
gap: 14px;
margin-bottom: 28px;
padding-bottom: 14px;
border-bottom: 2px solid var(--border);
}
.chapter-header .ch-badge {
display: inline-flex;
align-items: center;
justify-content: center;
width: 38px;
height: 38px;
border-radius: 8px;
background: var(--primary);
color: #fff;
font-size: 16px;
font-weight: 800;
flex-shrink: 0;
}
.chapter-header h2 {
font-size: 1.5rem;
font-weight: 700;
letter-spacing: -0.01em;
border: none;
padding: 0;
margin: 0;
}
/* ---- SECTIONS ---- */
.section { margin-bottom: 48px; }
h3 {
font-size: 1.15rem;
font-weight: 600;
margin: 28px 0 12px;
color: var(--primary);
}
h4 {
font-size: 1rem;
font-weight: 600;
margin: 20px 0 8px;
}
p { margin-bottom: 14px; }
ul, ol { margin-bottom: 14px; padding-left: 24px; }
li { margin-bottom: 6px; }
/* ---- CARDS ---- */
.card {
background: var(--surface);
border: 1px solid var(--border);
border-radius: var(--radius);
padding: 20px 24px;
margin-bottom: 16px;
box-shadow: var(--shadow);
}
.card h4 { margin: 0 0 6px; }
.card p { margin-bottom: 0; }
/* ---- FEATURE GRID ---- */
.feature-grid {
display: grid;
grid-template-columns: 1fr 1fr;
gap: 14px;
margin-bottom: 20px;
}
.feature-grid .card { margin-bottom: 0; }
/* ---- STEPS ---- */
.steps {
counter-reset: step;
list-style: none;
padding: 0;
}
.steps li {
counter-increment: step;
position: relative;
padding: 2px 0 18px 50px;
margin-bottom: 2px;
}
.steps li::before {
content: counter(step);
position: absolute;
left: 0;
top: 0;
width: 32px;
height: 32px;
background: var(--primary);
color: #fff;
border-radius: 50%;
display: flex;
align-items: center;
justify-content: center;
font-weight: 700;
font-size: 13px;
}
.steps li::after {
content: '';
position: absolute;
left: 15px;
top: 36px;
bottom: 0;
width: 2px;
background: var(--border);
}
.steps li:last-child::after { display: none; }
/* ---- CODE ---- */
pre {
background: var(--code-bg);
border: 1px solid var(--border);
border-radius: var(--radius);
padding: 14px 18px;
overflow-x: auto;
margin-bottom: 16px;
font-size: 13px;
line-height: 1.6;
}
code {
font-family: 'Cascadia Code', 'Fira Code', 'Consolas', monospace;
font-size: 0.88em;
}
p code, li code, td code {
background: var(--code-bg);
padding: 2px 6px;
border-radius: 4px;
border: 1px solid var(--border);
}
/* ---- TABLES ---- */
table {
width: 100%;
border-collapse: collapse;
margin-bottom: 20px;
font-size: 14px;
}
th, td {
text-align: left;
padding: 10px 14px;
border-bottom: 1px solid var(--border);
}
th {
font-weight: 600;
background: var(--code-bg);
font-size: 11px;
text-transform: uppercase;
letter-spacing: 0.05em;
color: var(--text-muted);
}
/* ---- CALLOUTS ---- */
.callout {
border-left: 4px solid var(--primary);
background: var(--primary-light);
padding: 14px 18px;
border-radius: 0 var(--radius) var(--radius) 0;
margin-bottom: 20px;
font-size: 14px;
}
.callout.tip { border-left-color: var(--success); }
.callout.warning { border-left-color: var(--warning); background: #fef3c7; }
.callout.danger { border-left-color: var(--danger); background: #fef2f2; }
@media (prefers-color-scheme: dark) {
.callout.warning { background: #422006; }
.callout.danger { background: #450a0a; }
}
.callout strong { display: block; margin-bottom: 4px; }
/* ---- KBD ---- */
kbd {
display: inline-block;
padding: 2px 7px;
font-family: inherit;
font-size: 12px;
font-weight: 600;
border: 1px solid var(--border);
border-radius: 4px;
background: var(--code-bg);
box-shadow: 0 1px 0 var(--border);
}
/* ---- SEARCH HIGHLIGHT ---- */
mark.search-hl {
background: var(--highlight);
color: inherit;
padding: 1px 2px;
border-radius: 2px;
}
.section.search-hidden { display: none; }
.chapter-group.search-hidden { display: none; }
/* ---- BACK TO TOP ---- */
#back-to-top {
position: fixed;
bottom: 28px;
right: 28px;
width: 40px;
height: 40px;
border-radius: 50%;
border: 1px solid var(--border);
background: var(--surface);
color: var(--text-muted);
cursor: pointer;
font-size: 18px;
display: none;
align-items: center;
justify-content: center;
box-shadow: var(--shadow-md);
transition: opacity 0.2s;
z-index: 50;
}
#back-to-top.visible { display: flex; }
#back-to-top:hover { color: var(--primary); border-color: var(--primary); }
/* ---- CHAPTER SEPARATOR ---- */
.chapter-block {
margin-bottom: 64px;
padding-bottom: 32px;
border-bottom: 1px solid var(--border);
}
.chapter-block:last-of-type { border-bottom: none; }
/* ---- RESPONSIVE ---- */
@media (max-width: 960px) {
nav {
transform: translateX(-100%);
transition: transform 0.25s ease;
box-shadow: none;
}
nav.open {
transform: translateX(0);
box-shadow: 4px 0 20px rgba(0,0,0,0.15);
}
.nav-toggle { display: flex; }
.nav-overlay.open { display: block; }
main { margin-left: 0; padding: 60px 24px 80px; }
}
@media (max-width: 600px) {
.feature-grid { grid-template-columns: 1fr; }
.hero h1 { font-size: 1.7rem; }
main { padding: 56px 16px 64px; }
}
/* ---- SCROLL ---- */
[id] { scroll-margin-top: 24px; }
/* ---- PRINT ---- */
@media print {
nav, .nav-toggle, #back-to-top { display: none !important; }
main { margin-left: 0; max-width: 100%; padding: 20px; }
.hero { padding: 16px 0; }
.chapter-block { page-break-before: always; border: none; }
.chapter-block:first-of-type { page-break-before: auto; }
pre { white-space: pre-wrap; word-wrap: break-word; }
}
/* ---- FOOTER ---- */
.guide-footer {
text-align: center;
padding-top: 32px;
border-top: 1px solid var(--border);
color: var(--text-muted);
font-size: 13px;
}
</style>
</head>
<body>
<!-- ============ MOBILE NAV TOGGLE ============ -->
<button class="nav-toggle" id="nav-toggle" aria-label="Toggle navigation">☰</button>
<div class="nav-overlay" id="nav-overlay"></div>
<!-- ============ SIDEBAR NAV ============ -->
<nav id="sidebar">
<div class="nav-header">
<div class="brand">
<img class="logo" src="icon.png" alt="Sentinel">
<span>Sentinel</span>
</div>
<div class="search-wrap">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 20 20" fill="currentColor"><path fill-rule="evenodd" d="M9 3.5a5.5 5.5 0 100 11 5.5 5.5 0 000-11zM2 9a7 7 0 1112.452 4.391l3.328 3.329a.75.75 0 11-1.06 1.06l-3.329-3.328A7 7 0 012 9z" clip-rule="evenodd"/></svg>
<input type="text" id="search" placeholder="Search guide..." autocomplete="off" spellcheck="false">
<button id="search-clear" aria-label="Clear search">×</button>
</div>
<div class="search-info" id="search-info"></div>
</div>
<div class="nav-toc" id="nav-toc">
<!-- Ch 1 -->
<div class="chapter-group open" data-chapter="1">
<button class="chapter-toggle" onclick="toggleChapter(this)">
<span class="ch-num">1</span> Getting Started
<span class="ch-arrow">▶</span>
</button>
<div class="chapter-sections">
<a href="#1-1">1.1 Prerequisites</a>
<a href="#1-2">1.2 Build from Source</a>
<a href="#1-3">1.3 Load in Browser</a>
<a href="#1-4">1.4 Open the Side Panel</a>
</div>
</div>
<!-- Ch 2 -->
<div class="chapter-group" data-chapter="2">
<button class="chapter-toggle" onclick="toggleChapter(this)">
<span class="ch-num">2</span> Recording
<span class="ch-arrow">▶</span>
</button>
<div class="chapter-sections">
<a href="#2-1">2.1 Start a Recording</a>
<a href="#2-2">2.2 What Gets Captured</a>
<a href="#2-3">2.3 Noise Reduction</a>
</div>
</div>
<!-- Ch 3 -->
<div class="chapter-group" data-chapter="3">
<button class="chapter-toggle" onclick="toggleChapter(this)">
<span class="ch-num">3</span> Session Management
<span class="ch-arrow">▶</span>
</button>
<div class="chapter-sections">
<a href="#3-1">3.1 Save & Load</a>
<a href="#3-2">3.2 Rename & Delete</a>
<a href="#3-3">3.3 Storage</a>
</div>
</div>
<!-- Ch 4 -->
<div class="chapter-group" data-chapter="4">
<button class="chapter-toggle" onclick="toggleChapter(this)">
<span class="ch-num">4</span> Visual Guides
<span class="ch-arrow">▶</span>
</button>
<div class="chapter-sections">
<a href="#4-1">4.1 Export an HTML Guide</a>
<a href="#4-2">4.2 Guide Editor</a>
<a href="#4-3">4.3 Sharing Guides</a>
</div>
</div>
<!-- Ch 5 -->
<div class="chapter-group" data-chapter="5">
<button class="chapter-toggle" onclick="toggleChapter(this)">
<span class="ch-num">5</span> Playback
<span class="ch-arrow">▶</span>
</button>
<div class="chapter-sections">
<a href="#5-1">5.1 Start Playback</a>
<a href="#5-2">5.2 Playback Controls</a>
<a href="#5-3">5.3 Step-by-Step Mode</a>
</div>
</div>
<!-- Ch 6 -->
<div class="chapter-group" data-chapter="6">
<button class="chapter-toggle" onclick="toggleChapter(this)">
<span class="ch-num">6</span> Assertions & Testing
<span class="ch-arrow">▶</span>
</button>
<div class="chapter-sections">
<a href="#6-1">6.1 Adding Assertions</a>
<a href="#6-2">6.2 Assertion Types</a>
<a href="#6-3">6.3 Test Reports</a>
</div>
</div>
<!-- Ch 7 -->
<div class="chapter-group" data-chapter="7">
<button class="chapter-toggle" onclick="toggleChapter(this)">
<span class="ch-num">7</span> Error Tracking
<span class="ch-arrow">▶</span>
</button>
<div class="chapter-sections">
<a href="#7-1">7.1 Captured Errors</a>
<a href="#7-2">7.2 Issue Reports</a>
</div>
</div>
<!-- Ch 8 -->
<div class="chapter-group" data-chapter="8">
<button class="chapter-toggle" onclick="toggleChapter(this)">
<span class="ch-num">8</span> Video Recording
<span class="ch-arrow">▶</span>
</button>
<div class="chapter-sections">
<a href="#8-1">8.1 Capture a Video</a>
<a href="#8-2">8.2 Managing Clips</a>
<a href="#8-3">8.3 Limitations</a>
</div>
</div>
<!-- Ch 9 -->
<div class="chapter-group" data-chapter="9">
<button class="chapter-toggle" onclick="toggleChapter(this)">
<span class="ch-num">9</span> UI Reference
<span class="ch-arrow">▶</span>
</button>
<div class="chapter-sections">
<a href="#9-1">9.1 Side Panel Layout</a>
<a href="#9-2">9.2 Captured Keyboard Events</a>
</div>
</div>
<!-- Ch 10 -->
<div class="chapter-group" data-chapter="10">
<button class="chapter-toggle" onclick="toggleChapter(this)">
<span class="ch-num">10</span> AI Automation (MCP)
<span class="ch-arrow">▶</span>
</button>
<div class="chapter-sections">
<a href="#10-1">10.1 Overview</a>
<a href="#10-2">10.2 Setup & Installation</a>
<a href="#10-3">10.3 MCP Tools Reference</a>
<a href="#10-4">10.4 Settings Tab</a>
<a href="#10-5">10.5 Troubleshooting MCP</a>
<a href="#10-6">10.6 AI Workflow Examples</a>
</div>
</div>
<!-- Ch 11 -->
<div class="chapter-group" data-chapter="11">
<button class="chapter-toggle" onclick="toggleChapter(this)">
<span class="ch-num">11</span> Architecture
<span class="ch-arrow">▶</span>
</button>
<div class="chapter-sections">
<a href="#11-1">11.1 Project Structure</a>
<a href="#11-2">11.2 Tech Stack</a>
<a href="#11-3">11.3 Chrome APIs</a>
</div>
</div>
<!-- Ch 12 -->
<div class="chapter-group" data-chapter="12">
<button class="chapter-toggle" onclick="toggleChapter(this)">
<span class="ch-num">12</span> Troubleshooting
<span class="ch-arrow">▶</span>
</button>
<div class="chapter-sections">
<a href="#12-1">12.1 Common Issues</a>
<a href="#12-2">12.2 Development Workflow</a>
</div>
</div>
<div class="no-results" id="no-results">No matching sections found.</div>
</div>
</nav>
<!-- ============ MAIN CONTENT ============ -->
<main id="main-content">
<!-- HERO -->
<div class="hero" id="top">
<img src="icon.png" alt="Sentinel" class="hero-icon">
<h1>Sentinel User Guide</h1>
<p class="subtitle">A Chrome extension for recording web interactions, capturing bugs, and generating step-by-step visual guides — no code required.</p>
<div class="badge-row">
<span class="badge">Chrome MV3</span>
<span class="badge">Side Panel</span>
<span class="badge">React 19</span>
<span class="badge">TypeScript 5.9</span>
<span class="badge">Tailwind v4</span>
</div>
</div>
<!-- ======================== CHAPTER 1 ======================== -->
<div class="chapter-block" data-chapter="1">
<div class="chapter-header" id="ch-1">
<span class="ch-badge">1</span>
<h2>Getting Started</h2>
</div>
<div class="section" id="1-1" data-searchable>
<h3>1.1 Prerequisites</h3>
<ul>
<li><strong>Node.js 18+</strong> and <strong>npm</strong> installed on your system.</li>
<li>A Chromium-based browser: <strong>Google Chrome 114+</strong>, Microsoft Edge, or Brave.</li>
</ul>
</div>
<div class="section" id="1-2" data-searchable>
<h3>1.2 Build from Source</h3>
<p>Open a terminal in the project root and run:</p>
<pre><code>cd extension
npm install
npm run build</code></pre>
<p>This creates the <code>extension/dist/</code> folder containing the production-ready extension files.</p>
<div class="callout tip">
<strong>Development mode</strong>
Use <code>npm run dev</code> for live rebuilds during development. After each rebuild, reload the extension in your browser to pick up changes.
</div>
</div>
<div class="section" id="1-3" data-searchable>
<h3>1.3 Load in Your Browser</h3>
<ol class="steps">
<li>Open your browser and navigate to <code>chrome://extensions/</code>.</li>
<li>Enable <strong>Developer mode</strong> using the toggle in the top-right corner.</li>
<li>Click <strong>Load unpacked</strong>.</li>
<li>Select the <code>extension/dist</code> folder from this project.</li>
<li>Sentinel appears in your toolbar. <strong>Pin it</strong> for easy access.</li>
</ol>
</div>
<div class="section" id="1-4" data-searchable>
<h3>1.4 Open the Side Panel</h3>
<p>Click the Sentinel icon in your browser toolbar. The <strong>side panel</strong> opens alongside your current page and <strong>stays open</strong> while you interact with websites — unlike popups, it won't close when you click away.</p>
<div class="callout">
<strong>Why a side panel?</strong>
Side panels persist during page navigation and interaction, making them ideal for recording sessions that span multiple pages or long workflows.
</div>
</div>
</div>
<!-- ======================== CHAPTER 2 ======================== -->
<div class="chapter-block" data-chapter="2">
<div class="chapter-header" id="ch-2">
<span class="ch-badge">2</span>
<h2>Recording</h2>
</div>
<div class="section" id="2-1" data-searchable>
<h3>2.1 Start a Recording</h3>
<ol class="steps">
<li>Open the Sentinel side panel by clicking its toolbar icon.</li>
<li>Click <strong>Start Recording</strong> in the header controls.</li>
<li>Interact with any website — clicks, typing, form submissions, keyboard shortcuts, and scrolling are all captured automatically.</li>
<li>Watch recorded steps appear <strong>live</strong> in the Steps tab as you work.</li>
<li>Click <strong>Stop Recording</strong> when finished.</li>
</ol>
</div>
<div class="section" id="2-2" data-searchable>
<h3>2.2 What Gets Captured</h3>
<table>
<thead>
<tr><th>Event</th><th>Details</th></tr>
</thead>
<tbody>
<tr><td><strong>Clicks</strong></td><td>Buttons, links, inputs, and interactive elements. Layout-only containers (div, section) are filtered out unless they have roles or event handlers.</td></tr>
<tr><td><strong>Text Input</strong></td><td>Debounced at 800ms per element. Only the final value is captured on blur or timeout.</td></tr>
<tr><td><strong>Keyboard</strong></td><td>Special keys (Enter, Escape, Tab, arrows, F-keys) and modifier combos (Ctrl+S, etc.).</td></tr>
<tr><td><strong>Scrolling</strong></td><td>Debounced at 1 second with a 200px minimum distance threshold.</td></tr>
<tr><td><strong>Form Submit</strong></td><td>Captured on the submit event.</td></tr>
<tr><td><strong>Navigation</strong></td><td>Page URL changes are tracked automatically.</td></tr>
</tbody>
</table>
</div>
<div class="section" id="2-3" data-searchable>
<h3>2.3 Noise Reduction</h3>
<p>Sentinel applies intelligent filtering to keep recordings clean and readable:</p>
<ul>
<li><strong>Input debouncing</strong> — 800ms per element; only emits the final value on blur or timeout.</li>
<li><strong>Keyboard filtering</strong> — only special keys and modifier combos are recorded; regular typing is captured as input events.</li>
<li><strong>Click deduplication</strong> — clicks within 300ms of each other on the same element are merged.</li>
<li><strong>Layout container rejection</strong> — clicks on <code>div</code>, <code>section</code>, <code>main</code>, etc. are suppressed unless the element has a <code>role</code>, <code>onclick</code>, or <code>tabindex</code>.</li>
<li><strong>Scroll throttling</strong> — 1-second debounce with a 200px minimum distance threshold.</li>
<li><strong>Change events</strong> — removed entirely (redundant with debounced input).</li>
</ul>
</div>
</div>
<!-- ======================== CHAPTER 3 ======================== -->
<div class="chapter-block" data-chapter="3">
<div class="chapter-header" id="ch-3">
<span class="ch-badge">3</span>
<h2>Session Management</h2>
</div>
<div class="section" id="3-1" data-searchable>
<h3>3.1 Save & Load</h3>
<div class="feature-grid">
<div class="card">
<h4>Save</h4>
<p>Save the current recording for later use. Give it a meaningful name to keep your library organized.</p>
</div>
<div class="card">
<h4>Load</h4>
<p>Load any saved session to review its steps, continue editing, or play it back on the target website.</p>
</div>
</div>
</div>
<div class="section" id="3-2" data-searchable>
<h3>3.2 Rename & Delete</h3>
<div class="feature-grid">
<div class="card">
<h4>Rename</h4>
<p>Click the session name to edit it inline. Press Enter or click away to confirm.</p>
</div>
<div class="card">
<h4>Delete</h4>
<p>Remove sessions you no longer need. This action is immediate and cannot be undone.</p>
</div>
</div>
</div>
<div class="section" id="3-3" data-searchable>
<h3>3.3 Storage</h3>
<p>Sessions are stored in <code>chrome.storage.local</code> and persist across browser restarts. Storage is per-browser-profile — sessions are not synced across devices.</p>
</div>
</div>
<!-- ======================== CHAPTER 4 ======================== -->
<div class="chapter-block" data-chapter="4">
<div class="chapter-header" id="ch-4">
<span class="ch-badge">4</span>
<h2>Visual Guides</h2>
</div>
<div class="section" id="4-1" data-searchable>
<h3>4.1 Export an HTML Guide</h3>
<p>Turn any recording into a polished, self-contained HTML document with screenshots:</p>
<ol class="steps">
<li>Stop the current recording (or load a saved session).</li>
<li>Click <strong>Export HTML Guide</strong>.</li>
<li>A <code>.html</code> file downloads automatically.</li>
<li>Open it in any browser to see a step-by-step walkthrough with screenshots, selectors, and timestamps.</li>
</ol>
</div>
<div class="section" id="4-2" data-searchable>
<h3>4.2 Guide Editor</h3>
<p>Before exporting, refine your guide in the built-in editor. Click <strong>Edit Guide</strong> to open it in a new tab.</p>
<ul>
<li><strong>Three-column layout</strong> — table of contents sidebar, step editor, and live preview.</li>
<li><strong>Edit step descriptions</strong> — rewrite auto-generated text to match your documentation style.</li>
<li><strong>Reorder or remove steps</strong> — drag steps or delete irrelevant ones.</li>
<li><strong>Live preview</strong> — see exactly how the exported guide will look as you edit, with <code>contenteditable</code> support.</li>
</ul>
</div>
<div class="section" id="4-3" data-searchable>
<h3>4.3 Sharing Guides</h3>
<p>Exported guides are completely standalone — no external dependencies, all images embedded as base64. Share them via email, Slack, your team wiki, or any file-sharing platform. Anyone with a web browser can open them.</p>
</div>
</div>
<!-- ======================== CHAPTER 5 ======================== -->
<div class="chapter-block" data-chapter="5">
<div class="chapter-header" id="ch-5">
<span class="ch-badge">5</span>
<h2>Playback</h2>
</div>
<div class="section" id="5-1" data-searchable>
<h3>5.1 Start Playback</h3>