@knowcode/doc-builder 1.9.29 → 1.9.31

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (197) hide show
  1. package/assets/js/main.js +7 -0
  2. package/lib/core-builder.js +18 -1
  3. package/package.json +12 -2
  4. package/.claude/settings.local.json +0 -56
  5. package/CACHE-BUSTING-GUIDE.md +0 -82
  6. package/CLAUDE.md +0 -86
  7. package/CONTRIBUTING.md +0 -148
  8. package/GITHUB_SETUP.md +0 -203
  9. package/RELEASE-NOTES-1.7.5.md +0 -64
  10. package/Screenshot 2025-07-22 at 19.51.21.png +0 -0
  11. package/Screenshot 2025-07-26 at 17.06.49.png +0 -0
  12. package/add-user-clive.sql +0 -35
  13. package/add-user-lindsay-fixed.sql +0 -85
  14. package/add-user-lindsay.sql +0 -68
  15. package/add-user-pmorgan.sql +0 -35
  16. package/add-user-robbie.sql +0 -35
  17. package/add-wru-users.sql +0 -105
  18. package/debug-login.sql +0 -30
  19. package/doc-builder.config.js +0 -126
  20. package/doc-builder.config.js.backup.1753793768283 +0 -47
  21. package/doc-builder.config.js.backup.1753803964423 +0 -114
  22. package/doc-builder.config.js.backup.1753945707032 +0 -115
  23. package/doc-builder.config.js.backup.1754059241330 +0 -115
  24. package/doc-builder.config.js.backup.1754119567787 +0 -123
  25. package/doc-builder.config.js.backup.1754120048862 +0 -124
  26. package/doc-builder.config.js.backup.1754120529913 +0 -124
  27. package/doc-builder.config.js.backup.1754218469785 +0 -124
  28. package/doc-builder.config.js.backup.1754384764054 +0 -124
  29. package/doc-builder.config.js.backup.1754567425847 +0 -124
  30. package/doc-builder.config.js.backup.1754568137859 +0 -126
  31. package/doc-builder.config.js.backup.1754569388252 +0 -126
  32. package/doc-builder.config.js.backup.1754576694123 +0 -126
  33. package/doc-builder.config.js.backup.1755031374829 +0 -126
  34. package/doc-builder.config.js.backup.1755034500990 +0 -126
  35. package/grant-access.sql +0 -15
  36. package/html/11.png +0 -0
  37. package/html/404.html +0 -115
  38. package/html/README.html +0 -522
  39. package/html/Screenshot 2025-08-12 at 21.35.07.png +0 -0
  40. package/html/about-doc-builder.html +0 -491
  41. package/html/auth.js +0 -157
  42. package/html/claude-workflow-guide.html +0 -525
  43. package/html/css/notion-style.css +0 -2502
  44. package/html/documentation-index.html +0 -471
  45. package/html/guides/authentication-default-change.html +0 -370
  46. package/html/guides/authentication-guide.html +0 -509
  47. package/html/guides/cache-control-anti-pattern.html +0 -361
  48. package/html/guides/claude-workflow-guide.html +0 -1074
  49. package/html/guides/configuration-guide.html +0 -472
  50. package/html/guides/document-standards.html +0 -518
  51. package/html/guides/documentation-standards.html +0 -694
  52. package/html/guides/html-embedding-guide.html +0 -461
  53. package/html/guides/image-modal-guide.html +0 -515
  54. package/html/guides/next-steps-walkthrough.html +0 -638
  55. package/html/guides/phosphor-icons-guide.html +0 -584
  56. package/html/guides/private-directory-authentication-troubleshooting.html +0 -555
  57. package/html/guides/private-directory-authentication.html +0 -541
  58. package/html/guides/public-site-deployment.html +0 -431
  59. package/html/guides/search-engine-verification-guide.html +0 -542
  60. package/html/guides/seo-guide.html +0 -661
  61. package/html/guides/seo-optimization-guide.html +0 -887
  62. package/html/guides/supabase-auth-implementation-plan.html +0 -543
  63. package/html/guides/supabase-auth-integration-plan.html +0 -671
  64. package/html/guides/supabase-auth-setup-guide.html +0 -498
  65. package/html/guides/supabase-authentication-complete-guide.html +0 -866
  66. package/html/guides/troubleshooting-guide.html +0 -633
  67. package/html/guides/vercel-deployment-auth-setup.html +0 -337
  68. package/html/guides/windows-setup-guide.html +0 -859
  69. package/html/image-modal-test.html +0 -318
  70. package/html/index.html +0 -522
  71. package/html/js/auth.js +0 -157
  72. package/html/js/main.js +0 -1747
  73. package/html/launch/README.html +0 -297
  74. package/html/launch/bubble-plugin-specification.html +0 -933
  75. package/html/launch/go-to-market-strategy.html +0 -663
  76. package/html/launch/launch-announcements.html +0 -593
  77. package/html/login.html +0 -102
  78. package/html/logout.html +0 -18
  79. package/html/private/cache-control-anti-pattern.html +0 -429
  80. package/html/private/launch/README.html +0 -371
  81. package/html/private/launch/auth-cleanup-summary.html +0 -361
  82. package/html/private/launch/bubble-plugin-specification.html +0 -1007
  83. package/html/private/launch/go-to-market-strategy.html +0 -737
  84. package/html/private/launch/launch-announcements.html +0 -667
  85. package/html/private/launch/vercel-deployment-auth-setup.html +0 -417
  86. package/html/private/next-steps-walkthrough.html +0 -679
  87. package/html/private/supabase-auth-implementation-completed.html +0 -454
  88. package/html/private/supabase-auth-implementation-plan.html +0 -594
  89. package/html/private/supabase-auth-integration-plan.html +0 -704
  90. package/html/private/supabase-auth-setup-guide.html +0 -555
  91. package/html/private/test-private-doc.html +0 -302
  92. package/html/private/user-management-tooling.html +0 -601
  93. package/html/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
  94. package/html/prompts/beautiful-documentation-design.html +0 -784
  95. package/html/prompts/markdown-document-standards.html +0 -422
  96. package/html/prompts/project-rename-strategy-sasha-publish.html +0 -530
  97. package/html/robots.txt +0 -9
  98. package/html/sitemap.xml +0 -357
  99. package/html/test-questions/how-does-it-work%3F.html +0 -294
  100. package/html/test-questions/step-1%3A%20getting-started.html +0 -289
  101. package/html/test-questions/what-is-the-purpose.html +0 -293
  102. package/html/test-status.html +0 -281
  103. package/html/vercel-cli-setup-guide.html +0 -495
  104. package/html/vercel-first-time-setup-guide.html +0 -454
  105. package/html/vercel.json +0 -29
  106. package/html-static/11.png +0 -0
  107. package/html-static/404.html +0 -115
  108. package/html-static/README.html +0 -599
  109. package/html-static/Screenshot 2025-08-12 at 21.35.07.png +0 -0
  110. package/html-static/about-doc-builder.html +0 -568
  111. package/html-static/css/notion-style.css +0 -2502
  112. package/html-static/documentation-index.html +0 -548
  113. package/html-static/guides/authentication-default-change.html +0 -447
  114. package/html-static/guides/authentication-guide.html +0 -586
  115. package/html-static/guides/claude-workflow-guide.html +0 -1151
  116. package/html-static/guides/configuration-guide.html +0 -549
  117. package/html-static/guides/documentation-standards.html +0 -771
  118. package/html-static/guides/html-embedding-guide.html +0 -538
  119. package/html-static/guides/image-modal-guide.html +0 -592
  120. package/html-static/guides/phosphor-icons-guide.html +0 -661
  121. package/html-static/guides/private-directory-authentication-troubleshooting.html +0 -632
  122. package/html-static/guides/private-directory-authentication.html +0 -618
  123. package/html-static/guides/public-site-deployment.html +0 -508
  124. package/html-static/guides/search-engine-verification-guide.html +0 -619
  125. package/html-static/guides/seo-guide.html +0 -738
  126. package/html-static/guides/seo-optimization-guide.html +0 -964
  127. package/html-static/guides/supabase-authentication-complete-guide.html +0 -943
  128. package/html-static/guides/troubleshooting-guide.html +0 -710
  129. package/html-static/guides/windows-setup-guide.html +0 -936
  130. package/html-static/image-modal-test.html +0 -395
  131. package/html-static/index.html +0 -599
  132. package/html-static/js/main.js +0 -1747
  133. package/html-static/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
  134. package/html-static/prompts/beautiful-documentation-design.html +0 -861
  135. package/html-static/prompts/markdown-document-standards.html +0 -499
  136. package/html-static/prompts/project-rename-strategy-sasha-publish.html +0 -607
  137. package/html-static/robots.txt +0 -5
  138. package/html-static/sitemap.xml +0 -195
  139. package/html-static/test-questions/how-does-it-work%3F.html +0 -371
  140. package/html-static/test-questions/step-1%3A%20getting-started.html +0 -366
  141. package/html-static/test-questions/what-is-the-purpose.html +0 -370
  142. package/html-static/vercel-cli-setup-guide.html +0 -572
  143. package/html-static/vercel-first-time-setup-guide.html +0 -531
  144. package/manage-users.sql +0 -191
  145. package/migrate-to-domain-auth.sql +0 -47
  146. package/package/CACHE-BUSTING-GUIDE.md +0 -82
  147. package/package/CHANGELOG.md +0 -902
  148. package/package/README.md +0 -248
  149. package/package/assets/css/notion-style.css +0 -2211
  150. package/package/assets/js/auth.js +0 -67
  151. package/package/assets/js/main.js +0 -1565
  152. package/package/cli.js +0 -764
  153. package/package/index.js +0 -38
  154. package/package/knowcode-doc-builder-1.3.15.tgz +0 -0
  155. package/package/lib/builder.js +0 -32
  156. package/package/lib/config.js +0 -278
  157. package/package/lib/core-builder.js +0 -957
  158. package/package/lib/deploy.js +0 -497
  159. package/package/lib/dev-server.js +0 -96
  160. package/package/package.json +0 -34
  161. package/package/scripts/npx-runner.js +0 -27
  162. package/package/scripts/setup.js +0 -56
  163. package/package/test-cache-bust.sh +0 -43
  164. package/public-config.js +0 -22
  165. package/public-html/404.html +0 -115
  166. package/public-html/README.html +0 -149
  167. package/public-html/css/notion-style.css +0 -2036
  168. package/public-html/index.html +0 -149
  169. package/public-html/js/auth.js +0 -67
  170. package/public-html/js/main.js +0 -1485
  171. package/quick-test-commands.md +0 -40
  172. package/recordings/Screenshot 2025-07-24 at 18.22.01.png +0 -0
  173. package/recordings/mh-ls-22jul.txt +0 -2305
  174. package/screenshot.png +0 -0
  175. package/scripts/Screenshot 2025-07-23 at 15.39.41.png +0 -0
  176. package/setup-database-v2.sql +0 -53
  177. package/setup-database.sql +0 -41
  178. package/test-auth-config.js +0 -17
  179. package/test-cache-bust.sh +0 -43
  180. package/test-docs/README.md +0 -39
  181. package/test-html/404.html +0 -115
  182. package/test-html/README.html +0 -172
  183. package/test-html/auth.js +0 -97
  184. package/test-html/css/notion-style.css +0 -2036
  185. package/test-html/index.html +0 -172
  186. package/test-html/js/auth.js +0 -97
  187. package/test-html/js/main.js +0 -1485
  188. package/test-html/login.html +0 -102
  189. package/test-html/logout.html +0 -18
  190. package/update-domain.sql +0 -9
  191. package/user-access-view.sql +0 -49
  192. package/user-management/README.md +0 -301
  193. package/user-management/add-users.sh +0 -776
  194. package/user-management/create-user.js +0 -65
  195. package/user-management/users.txt +0 -15
  196. package/view-all-users.sql +0 -40
  197. package/wru-auth-config.js +0 -17
@@ -1,771 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="UTF-8">
5
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
- <meta name="description" content="This document defines the documentation standards and conventions for the @knowcode/doc-builder project. All documentation created for or by this project...">
7
- <title>Document Standards for @knowcode/doc-builder</title>
8
-
9
- <meta name="generator" content="@knowcode/doc-builder by Knowcode Ltd">
10
- <meta name="author" content="Lindsay Smith">
11
- <meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, document, use">
12
- <meta name="robots" content="index, follow">
13
- <link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/documentation-standards.html">
14
-
15
- <!-- Open Graph / Facebook -->
16
- <meta property="og:type" content="article">
17
- <meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/documentation-standards.html">
18
- <meta property="og:title" content="Document Standards for @knowcode/doc-builder">
19
- <meta property="og:description" content="This document defines the documentation standards and conventions for the @knowcode/doc-builder project. All documentation created for or by this project...">
20
- <meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
21
- <meta property="og:site_name" content="@knowcode/doc-builder">
22
- <meta property="og:locale" content="en_US">
23
-
24
- <!-- Twitter Card -->
25
- <meta name="twitter:card" content="summary_large_image">
26
- <meta name="twitter:site" content="@planbbackups">
27
- <meta name="twitter:creator" content="@planbbackups">
28
- <meta name="twitter:title" content="Document Standards for @knowcode/doc-builder">
29
- <meta name="twitter:description" content="This document defines the documentation standards and conventions for the @knowcode/doc-builder project. All documentation created for or by this project...">
30
- <meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
31
-
32
- <!-- Custom Meta Tags -->
33
- <meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
34
- <meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
35
-
36
- <!-- Fonts -->
37
- <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
38
-
39
- <!-- Icons -->
40
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
41
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
42
-
43
- <!-- Mermaid -->
44
- <script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
45
-
46
- <!-- Styles -->
47
- <link rel="stylesheet" href="../css/notion-style.css">
48
-
49
-
50
- <!-- Blue theme and white background overrides for static output -->
51
- <style>
52
- /* Override green colors with blue */
53
- :root {
54
- --primary: #2563eb;
55
- --primary-dark: #1d4ed8;
56
- --primary-light: #dbeafe;
57
- --accent: #3b82f6;
58
- --color-accent-green: #2563eb;
59
- --color-accent-emerald: #3b82f6;
60
-
61
- /* White backgrounds for cleaner appearance */
62
- --color-bg-secondary: #FFFFFF;
63
- --color-bg-tertiary: #FAFAFA;
64
- --color-bg-hover: #F8F9FA;
65
- }
66
-
67
- /* Override green status colors with blue variants */
68
- .nav-item.active {
69
- background-color: #dbeafe !important;
70
- color: #1d4ed8 !important;
71
- }
72
-
73
- .nav-item:hover {
74
- background-color: #eff6ff !important;
75
- }
76
-
77
- /* Override complete/success icons to blue */
78
- .ph-check-circle[style*="color: #059669"] {
79
- color: #2563eb !important;
80
- }
81
-
82
- /* Override README/home icon color */
83
- .ph-house[style*="color: #059669"] {
84
- color: #2563eb !important;
85
- }
86
-
87
- /* Override links */
88
- a {
89
- color: #2563eb;
90
- }
91
-
92
- a:hover {
93
- color: #1d4ed8;
94
- }
95
-
96
- /* Override buttons and interactive elements */
97
- .theme-toggle:hover,
98
- .menu-toggle:hover {
99
- background-color: #dbeafe;
100
- color: #1d4ed8;
101
- }
102
-
103
- /* Override nav title hover */
104
- .nav-title:hover {
105
- background-color: #eff6ff;
106
- }
107
-
108
- /* White backgrounds for sidebar and navigation */
109
- body:not(.dark-mode) .sidebar {
110
- background: #FFFFFF !important;
111
- background-color: #FFFFFF !important;
112
- border-right: 1px solid #E5E7EB !important;
113
- }
114
-
115
- body:not(.dark-mode) .nav-section {
116
- background: #FFFFFF !important;
117
- background-color: #FFFFFF !important;
118
- }
119
-
120
- body:not(.dark-mode) .nav-content {
121
- background: #FFFFFF !important;
122
- background-color: #FFFFFF !important;
123
- }
124
-
125
- body:not(.dark-mode) .navigation {
126
- background: #FFFFFF !important;
127
- background-color: #FFFFFF !important;
128
- }
129
-
130
- /* Subtle separation for nav sections */
131
- body:not(.dark-mode) .nav-section + .nav-section {
132
- border-top: 1px solid #F3F4F6;
133
- }
134
-
135
- /* Adjust hover states for white backgrounds */
136
- body:not(.dark-mode) .nav-item:hover {
137
- background-color: #F8F9FA !important;
138
- }
139
-
140
- body:not(.dark-mode) .nav-title.collapsible:hover {
141
- background-color: #F8F9FA !important;
142
- }
143
-
144
- /* Header stays white (already is) but ensure consistency */
145
- body:not(.dark-mode) .header {
146
- background: #FFFFFF !important;
147
- background-color: #FFFFFF !important;
148
- border-bottom: 1px solid #E5E7EB !important;
149
- }
150
-
151
- /* Ensure search box looks good on white */
152
- body:not(.dark-mode) .filter-input,
153
- body:not(.dark-mode) .sidebar-search {
154
- background: #F8F9FA !important;
155
- background-color: #F8F9FA !important;
156
- border: 1px solid #E5E7EB !important;
157
- }
158
-
159
- body:not(.dark-mode) .filter-input:focus,
160
- body:not(.dark-mode) .sidebar-search:focus {
161
- background: #FFFFFF !important;
162
- background-color: #FFFFFF !important;
163
- border-color: #2563eb !important;
164
- }
165
-
166
- /* Override breadcrumbs */
167
- .breadcrumbs a {
168
- color: #2563eb;
169
- }
170
-
171
- .breadcrumbs a:hover {
172
- color: #1d4ed8;
173
- background-color: #dbeafe;
174
- }
175
-
176
- /* Override filter icon */
177
- .filter-icon {
178
- color: #2563eb;
179
- }
180
-
181
- /* Override deployment info on hover */
182
- .deployment-date:hover {
183
- color: #2563eb;
184
- }
185
-
186
- /* Dark mode adjustments */
187
- body.dark-mode {
188
- --primary: #3b82f6;
189
- --primary-dark: #2563eb;
190
- --primary-light: #1e3a8a;
191
- --accent: #60a5fa;
192
- }
193
-
194
- body.dark-mode .nav-item.active {
195
- background-color: rgba(59, 130, 246, 0.1) !important;
196
- color: #60a5fa !important;
197
- }
198
-
199
- body.dark-mode .nav-item:hover {
200
- background-color: rgba(59, 130, 246, 0.05) !important;
201
- }
202
-
203
- body.dark-mode a {
204
- color: #60a5fa;
205
- }
206
-
207
- body.dark-mode a:hover {
208
- color: #93bbfc;
209
- }
210
- </style>
211
-
212
-
213
-
214
-
215
- <!-- Favicon -->
216
- <link rel="icon" href="data:image/svg+xml,<svg xmlns=%22http://www.w3.org/2000/svg%22 viewBox=%220 0 100 100%22><text y=%22.9em%22 font-size=%2290%22>✨</text></svg>">
217
-
218
- <script type="application/ld+json">
219
- {
220
- "@context": "https://schema.org",
221
- "@type": "TechArticle",
222
- "headline": "Document Standards for @knowcode/doc-builder",
223
- "description": "This document defines the documentation standards and conventions for the @knowcode/doc-builder project. All documentation created for or by this project...",
224
- "author": {
225
- "@type": "Person",
226
- "name": "Lindsay Smith"
227
- },
228
- "publisher": {
229
- "@type": "Organization",
230
- "name": "Knowcode Ltd",
231
- "url": "https://knowcode.tech"
232
- },
233
- "datePublished": "2025-08-12T21:35:01.272Z",
234
- "dateModified": "2025-08-12T21:35:01.272Z",
235
- "mainEntityOfPage": {
236
- "@type": "WebPage",
237
- "@id": "https://doc-builder-delta.vercel.app/guides/documentation-standards.html"
238
- },
239
- "breadcrumb": {
240
- "@type": "BreadcrumbList",
241
- "itemListElement": [
242
- {
243
- "@type": "ListItem",
244
- "position": 1,
245
- "name": "@knowcode/doc-builder",
246
- "item": "https://doc-builder-delta.vercel.app"
247
- },
248
- {
249
- "@type": "ListItem",
250
- "position": 2,
251
- "name": "Guides",
252
- "item": "https://doc-builder-delta.vercel.app/guides/"
253
- },
254
- {
255
- "@type": "ListItem",
256
- "position": 3,
257
- "name": "Documentation Standards",
258
- "item": "https://doc-builder-delta.vercel.app/guides/documentation-standards.html"
259
- }
260
- ]
261
- }
262
- }
263
- </script>
264
- </head>
265
- <body>
266
-
267
-
268
-
269
-
270
- <!-- Breadcrumbs -->
271
- <nav class="breadcrumbs breadcrumbs-static" id="breadcrumbs" data-build-date="Aug 12, 2025, 09:35 PM UTC" data-doc-builder-version="1.9.28">
272
- <!-- Breadcrumbs will be generated by JavaScript -->
273
- </nav>
274
-
275
- <!-- Main Content -->
276
- <div class="main-wrapper">
277
- <!-- Sidebar -->
278
- <aside class="sidebar">
279
- <div class="sidebar-header">
280
- <div class="filter-box">
281
- <input type="text" placeholder="Search menu..." class="filter-input" id="nav-filter">
282
- <i class="fas fa-search filter-icon"></i>
283
- </div>
284
- </div>
285
- <nav class="navigation">
286
-
287
- <div class="nav-section" data-level="0">
288
- <a class="nav-title toggle-all-nav expanded" href="#" id="nav-toggle-all" title="Collapse/Expand All">
289
- <i class="ph ph-caret-down" id="toggle-all-icon"></i> Documentation
290
- </a>
291
- <div class="nav-content">
292
- <a href="README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="ph ph-file-text"></i> Overview</a>
293
- <a href="about-doc-builder.html" class="nav-item" data-tooltip="About @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #2563eb;"></i> About Doc Builder</a>
294
- <a href="documentation-index.html" class="nav-item" data-tooltip="This directory contains additional documentation for the @knowcode/doc-builder project, organized by topic and purpose."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Index</a>
295
- <a href="image-modal-test.html" class="nav-item" data-tooltip="This document tests the new image modal functionality in doc-builder."><i class="ph ph-file-text"></i> Image Modal Test</a>
296
- <a href="vercel-cli-setup-guide.html" class="nav-item" data-tooltip="This guide provides comprehensive instructions for installing the Vercel CLI across different operating systems."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Vercel Cli Setup Guide</a>
297
- <a href="vercel-first-time-setup-guide.html" class="nav-item" data-tooltip="This guide walks you through the Vercel deployment process when using ."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Vercel First Time Setup Guide</a></div></div>
298
- <div class="nav-section" data-level="1">
299
- <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
300
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-book"></i> Guides
301
- </a>
302
- <div class="nav-content" id="nav-guides-1">
303
- <a href="guides/authentication-default-change.html" class="nav-item" data-tooltip="Starting from version 1.7.4, @knowcode/doc-builder now defaults to no authentication for all documentation sites."><i class="ph ph-file-text"></i> Authentication Default Change</a>
304
- <a href="guides/authentication-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder supports enterprise-grade authentication through Supabase - a secure, scalable authentication platform."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Authentication Guide</a>
305
- <a href="guides/claude-workflow-guide.html" class="nav-item" data-tooltip="This guide demonstrates an efficient workflow for using Claude Code with a refined CLAUDE.md file to create high-quality documentation and deploy it..."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Claude Workflow Guide</a>
306
- <a href="guides/configuration-guide.html" class="nav-item" data-tooltip="This guide explains how @knowcode/doc-builder handles configuration files and settings."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Configuration Guide</a>
307
- <a href="guides/documentation-standards.html" class="nav-item active" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Documentation Standards</a>
308
- <a href="guides/html-embedding-guide.html" class="nav-item" data-tooltip="Starting from version 1.9.2, doc-builder treats HTML files ( and ) as attachments that are automatically copied to your output directory during the..."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Html Embedding Guide</a>
309
- <a href="guides/image-modal-guide.html" class="nav-item" data-tooltip="When users click on any image in your generated documentation, it opens in a professional modal overlay with: Full-screen viewing experience Smooth..."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Image Modal Guide</a>
310
- <a href="guides/phosphor-icons-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder automatically converts Unicode emojis in your markdown files to beautiful Phosphor icons in the generated HTML."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Phosphor Icons Guide</a>
311
- <a href="guides/private-directory-authentication.html" class="nav-item" data-tooltip="The @knowcode/doc-builder provides flexible authentication options to protect your documentation."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Private Directory Authentication</a>
312
- <a href="guides/private-directory-authentication-troubleshooting.html" class="nav-item" data-tooltip="Private Directory Authentication Troubleshooting."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Private Directory Authentication Troubleshooting</a>
313
- <a href="guides/public-site-deployment.html" class="nav-item" data-tooltip="The @knowcode/doc-builder now supports deploying public documentation sites without authentication."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Public Site Deployment</a>
314
- <a href="guides/search-engine-verification-guide.html" class="nav-item" data-tooltip="Search engine verification provides access to powerful webmaster tools:."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Search Engine Verification Guide</a>
315
- <a href="guides/seo-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features to help your documentation rank better in search results and..."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Seo Guide</a>
316
- <a href="guides/seo-optimization-guide.html" class="nav-item" data-tooltip="Comprehensive guide to optimizing documentation for search engines. Learn SEO best practices, use built-in features, and improve your rankings."><i class="ph ph-check-circle" style="color: #2563eb;"></i> SEO Optimization Guide for @knowcode/doc-builder</a>
317
- <a href="guides/supabase-authentication-complete-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes built-in Supabase authentication that provides enterprise-grade security with zero configuration."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Supabase Authentication Complete Guide</a>
318
- <a href="guides/troubleshooting-guide.html" class="nav-item" data-tooltip="This guide helps you resolve common issues when using @knowcode/doc-builder."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Troubleshooting Guide</a>
319
- <a href="guides/windows-setup-guide.html" class="nav-item" data-tooltip="This guide helps Windows users set up the complete AI-powered documentation workflow using Claude Code, @knowcode/doc-builder, and Vercel."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Windows Setup Guide</a></div></div>
320
- <div class="nav-section" data-level="1">
321
- <a class="nav-title collapsible" href="#" data-target="nav-prompts-1" >
322
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-chat-circle-dots"></i> Prompts
323
- </a>
324
- <div class="nav-content collapsed" id="nav-prompts-1">
325
- <a href="prompts/beautiful-documentation-design.html" class="nav-item" data-tooltip="🎨 Beautiful Documentation Design Guide."><i class="ph ph-check-circle" style="color: #2563eb;"></i> Beautiful Documentation Design</a>
326
- <a href="prompts/markdown-document-standards.html" class="nav-item" data-tooltip="Detailed introduction to the topic..."><i class="ph ph-pencil-simple" style="color: #d97706;"></i> Markdown Document Standards</a>
327
- <a href="prompts/project-rename-strategy-sasha-publish.html" class="nav-item" data-tooltip="This document outlines the comprehensive strategy for renaming the @knowcode/doc-builder project to &quot;sasha-publish&quot;, including all package references,..."><i class="ph ph-x-circle" style="color: #dc2626;"></i> Project Rename Strategy Sasha Publish</a></div></div>
328
- <div class="nav-section" data-level="1">
329
- <a class="nav-title collapsible" href="#" data-target="nav-test-questions-1" >
330
- <i class="ph ph-caret-right collapse-icon"></i><i class="ph ph-folder"></i> Test Questions
331
- </a>
332
- <div class="nav-content collapsed" id="nav-test-questions-1">
333
- <a href="test-questions/how-does-it-work%3F.html" class="nav-item" data-tooltip="This is a test file to verify that question marks work properly in filenames."><i class="ph ph-file-text"></i> How Does It Work?</a>
334
- <a href="test-questions/step-1%3A%20getting-started.html" class="nav-item" data-tooltip="Step 1: Getting Started."><i class="ph ph-file-text"></i> Step 1: Getting Started</a>
335
- <a href="test-questions/what-is-the-purpose.html" class="nav-item" data-tooltip="Understanding the purpose of our documentation system"><i class="ph ph-file-text"></i> What Is The Purpose?</a></div></div>
336
- </nav>
337
- <div class="resize-handle"></div>
338
- </aside>
339
-
340
- <!-- Content Area -->
341
- <main class="content">
342
- <div class="content-inner">
343
- <h1>Document Standards for @knowcode/doc-builder</h1>
344
- <h2>Overview</h2>
345
- <p>This document defines the documentation standards and conventions for the @knowcode/doc-builder project. All documentation created for or by this project should follow these guidelines to ensure consistency, clarity, and maintainability.</p>
346
- <h2>Document Structure Standards</h2>
347
- <h3>Document Header Format</h3>
348
- <p>Every document MUST include the following metadata at the top:</p>
349
- <pre><code class="language-markdown"># Document Title
350
-
351
- **Generated**: YYYY-MM-DD HH:MM UTC
352
- **Status**: Draft/In Progress/Complete
353
- **Verified**: ✅ (for verified information) / ❓ (for speculated information)
354
-
355
- ## Overview
356
-
357
- Brief description of the document&#39;s contents and purpose.
358
- </code></pre>
359
- <h3>Section Organization</h3>
360
- <ol>
361
- <li><strong>Title</strong> (H1) - Single, descriptive title</li>
362
- <li><strong>Metadata</strong> - Generation date, status, verification</li>
363
- <li><strong>Overview</strong> - Brief summary of document purpose</li>
364
- <li><strong>Main Content</strong> - Organized with clear headings</li>
365
- <li><strong>Document History</strong> - Track significant changes</li>
366
- </ol>
367
- <h2>Naming Conventions</h2>
368
- <h3>Document File Names</h3>
369
- <p>Use lowercase with hyphens, following these patterns:</p>
370
- <ul>
371
- <li><strong>Feature Documentation</strong>: <code>feature-{name}-guide.md</code></li>
372
- <li><strong>API Documentation</strong>: <code>api-{endpoint}-reference.md</code></li>
373
- <li><strong>Technical Guides</strong>: <code>{component}-{topic}-guide.md</code></li>
374
- <li><strong>Architecture Documents</strong>: <code>architecture-{system}-overview.md</code></li>
375
- <li><strong>Implementation Plans</strong>: <code>plan-{feature}-implementation.md</code></li>
376
- <li><strong>Analysis Documents</strong>: <code>analysis-{topic}-{specifics}.md</code></li>
377
- <li><strong>Troubleshooting Guides</strong>: <code>troubleshoot-{issue}-guide.md</code></li>
378
- <li><strong>Change Logs</strong>: <code>CHANGELOG.md</code> (always uppercase)</li>
379
- </ul>
380
- <h3>Special Files</h3>
381
- <ul>
382
- <li><code>README.md</code> - Project overview and getting started</li>
383
- <li><code>CHANGELOG.md</code> - Version history following Keep a Changelog format</li>
384
- <li><code>CLAUDE.md</code> - AI assistant guidance (project-specific)</li>
385
- <li><code>DOCUMENT-STANDARDS.md</code> - This file</li>
386
- </ul>
387
- <h2>Content Standards</h2>
388
- <h3>1. Mermaid Diagrams</h3>
389
- <p>Include diagrams wherever they help explain complex concepts:</p>
390
- <pre><code class="language-markdown"><div class="mermaid-wrapper">
391
- <div class="mermaid">graph TD
392
- A[User Input] --> B{Valid?}
393
- B -->|Yes| C[Process]
394
- B -->|No| D[Error]
395
- C --> E[Output]
396
-
397
- style A fill:#f9f,stroke:#333,stroke-width:2px
398
- style E fill:#9f9,stroke:#333,stroke-width:2px</div>
399
- </div>
400
- </code></pre>
401
- <p>Guidelines:</p>
402
- <ul>
403
- <li>Use consistent node naming</li>
404
- <li>Add clear labels and descriptions</li>
405
- <li>Apply styling for better visual hierarchy</li>
406
- <li>Include diagram titles where appropriate</li>
407
- </ul>
408
- <h3>2. Information Verification</h3>
409
- <p>Mark all information with verification status:</p>
410
- <ul>
411
- <li><i style="font-size: 1.2em" class="ph ph-check-circle" aria-label="checked"></i> <strong>Verified</strong>: Information confirmed through testing or official sources</li>
412
- <li><i style="font-size: 1.2em" class="ph ph-question" aria-label="question"></i> <strong>Speculated</strong>: Assumptions or unconfirmed information</li>
413
- <li><i style="font-size: 1.2em" class="ph ph-warning-circle" aria-label="warning"></i> <strong>Warning</strong>: Important caveats or potential issues</li>
414
- <li><i style="font-size: 1.2em" class="ph ph-barricade" aria-label="under construction"></i> <strong>In Progress</strong>: Features or documentation under development</li>
415
- </ul>
416
- <p>Example:</p>
417
- <pre><code class="language-markdown">### Feature Status
418
- - ✅ **Markdown parsing**: Fully implemented and tested
419
- - ❓ **Performance impact**: Estimated 100ms for 50 files
420
- - ⚠️ **Large files**: May timeout on files &gt; 10MB
421
- - 🚧 **Search feature**: Currently in development
422
- </code></pre>
423
- <h3>3. Code Examples</h3>
424
- <p>Always include practical, tested examples:</p>
425
- <pre><code class="language-javascript">// Good example - with context and error handling
426
- const { build } = require(&#39;@knowcode/doc-builder&#39;);
427
-
428
- const config = {
429
- siteName: &#39;My Documentation&#39;,
430
- docsDir: &#39;./docs&#39;,
431
- outputDir: &#39;./dist&#39;
432
- };
433
-
434
- try {
435
- await build(config);
436
- console.log(&#39;✅ Build successful&#39;);
437
- } catch (error) {
438
- console.error(&#39;❌ Build failed:&#39;, error.message);
439
- }
440
- </code></pre>
441
- <p>Guidelines:</p>
442
- <ul>
443
- <li>Use syntax highlighting</li>
444
- <li>Include error handling</li>
445
- <li>Add helpful comments</li>
446
- <li>Show both correct and incorrect usage</li>
447
- <li>Test all examples before documenting</li>
448
- </ul>
449
- <h3>4. Command Examples</h3>
450
- <p>Format commands clearly with descriptions:</p>
451
- <pre><code class="language-bash"># Install the package
452
- npm install -D @knowcode/doc-builder
453
-
454
- # Build documentation
455
- npx doc-builder build
456
-
457
- # Start development server
458
- npx doc-builder dev --port 3000
459
-
460
- # Deploy to Vercel
461
- npx doc-builder deploy --prod
462
- </code></pre>
463
- <h2>Version Control Standards</h2>
464
- <h3>Changelog Management</h3>
465
- <p>ALWAYS maintain <code>CHANGELOG.md</code> for all significant or material changes:</p>
466
- <pre><code class="language-markdown">## [1.4.12] - 2025-07-21
467
-
468
- ### Fixed
469
- - Fixed h1 title alignment to extend full width
470
- - Added negative margins to counteract padding
471
-
472
- ### Background
473
- - The h1 was appearing offset due to content padding
474
- - Now extends full width for better hierarchy
475
- </code></pre>
476
- <p>Categories:</p>
477
- <ul>
478
- <li><strong>Added</strong> - New features</li>
479
- <li><strong>Changed</strong> - Changes to existing functionality</li>
480
- <li><strong>Deprecated</strong> - Soon-to-be removed features</li>
481
- <li><strong>Removed</strong> - Removed features</li>
482
- <li><strong>Fixed</strong> - Bug fixes</li>
483
- <li><strong>Security</strong> - Security fixes</li>
484
- <li><strong>Background</strong> - Context for the changes</li>
485
- </ul>
486
- <h3>Commit Messages</h3>
487
- <p>Follow conventional commits:</p>
488
- <ul>
489
- <li><code>feat:</code> New features</li>
490
- <li><code>fix:</code> Bug fixes</li>
491
- <li><code>docs:</code> Documentation changes</li>
492
- <li><code>chore:</code> Maintenance tasks</li>
493
- <li><code>refactor:</code> Code refactoring</li>
494
- <li><code>test:</code> Test additions/changes</li>
495
- </ul>
496
- <h2>Markdown Best Practices</h2>
497
- <h3>Headers</h3>
498
- <pre><code class="language-markdown"># Main Title (H1 - one per document)
499
-
500
- ## Major Section (H2)
501
-
502
- ### Subsection (H3)
503
-
504
- #### Detail Level (H4)
505
- </code></pre>
506
- <ul>
507
- <li>Use hierarchical structure</li>
508
- <li>Don&#39;t skip levels</li>
509
- <li>Keep headers concise but descriptive</li>
510
- </ul>
511
- <h3>Lists</h3>
512
- <p>Unordered lists for non-sequential items:</p>
513
- <pre><code class="language-markdown">- First item
514
- - Second item
515
- - Nested item
516
- - Another nested item
517
- - Third item
518
- </code></pre>
519
- <p>Numbered lists for sequential steps:</p>
520
- <pre><code class="language-markdown">1. First step
521
- 2. Second step
522
- 3. Third step
523
- </code></pre>
524
- <h3>Tables</h3>
525
- <p>Keep tables readable and well-formatted:</p>
526
- <pre><code class="language-markdown">| Feature | Status | Version | Notes |
527
- |---------|--------|---------|-------|
528
- | Mermaid | ✅ Ready | 1.0.0 | Full support |
529
- | Search | 🚧 WIP | 1.5.0 | In development |
530
- | Auth | ✅ Ready | 1.3.0 | Optional feature |
531
- </code></pre>
532
- <h3>Links</h3>
533
- <ul>
534
- <li>Use descriptive link text: <code>[View deployment guide](./deploy.md)</code></li>
535
- <li>Avoid: <code>[click here](./deploy.md)</code></li>
536
- <li>Prefer relative links for internal docs</li>
537
- <li>Use absolute URLs for external resources</li>
538
- </ul>
539
- <h2>Quality Standards</h2>
540
- <h3>Clarity</h3>
541
- <ul>
542
- <li>Write for your target audience</li>
543
- <li>Define technical terms on first use</li>
544
- <li>Use simple language where possible</li>
545
- <li>Include examples for complex concepts</li>
546
- </ul>
547
- <h3>Completeness</h3>
548
- <ul>
549
- <li>Cover all aspects of the topic</li>
550
- <li>Include edge cases and limitations</li>
551
- <li>Document prerequisites</li>
552
- <li>Provide troubleshooting guidance</li>
553
- </ul>
554
- <h3>Accuracy</h3>
555
- <ul>
556
- <li>Verify all technical details</li>
557
- <li>Test code examples</li>
558
- <li>Update when implementation changes</li>
559
- <li>Mark speculation clearly</li>
560
- </ul>
561
- <h3>Consistency</h3>
562
- <ul>
563
- <li>Use same terminology throughout</li>
564
- <li>Follow naming conventions</li>
565
- <li>Maintain style consistency</li>
566
- <li>Cross-reference related documents</li>
567
- </ul>
568
- <h2>Document Types</h2>
569
- <h3>1. Feature Documentation</h3>
570
- <p>Structure:</p>
571
- <pre><code class="language-markdown"># Feature Name
572
-
573
- **Generated**: [date]
574
- **Status**: Complete
575
- **Verified**: ✅
576
-
577
- ## Overview
578
- What the feature does and why it exists
579
-
580
- ## Usage
581
- How to use the feature with examples
582
-
583
- ## Configuration
584
- Available options and settings
585
-
586
- ## Examples
587
- Practical use cases
588
-
589
- ## Troubleshooting
590
- Common issues and solutions
591
- </code></pre>
592
- <h3>2. Technical Guides</h3>
593
- <p>Structure:</p>
594
- <pre><code class="language-markdown"># Technical Guide: [Topic]
595
-
596
- **Generated**: [date]
597
- **Status**: Complete
598
- **Verified**: ✅
599
-
600
- ## Overview
601
- Technical context and goals
602
-
603
- ## Architecture
604
- System design and components
605
-
606
- ## Implementation
607
- Step-by-step technical details
608
-
609
- ## Testing
610
- How to verify functionality
611
-
612
- ## Performance
613
- Benchmarks and optimization
614
- </code></pre>
615
- <h3>3. API Documentation</h3>
616
- <p>Structure:</p>
617
- <pre><code class="language-markdown"># API: [Endpoint/Function Name]
618
-
619
- **Generated**: [date]
620
- **Status**: Complete
621
- **Verified**: ✅
622
-
623
- ## Overview
624
- What the API does
625
-
626
- ## Parameters
627
- | Name | Type | Required | Description |
628
- |------|------|----------|-------------|
629
-
630
- ## Response
631
- Expected response format
632
-
633
- ## Examples
634
- Request/response examples
635
-
636
- ## Error Handling
637
- Possible errors and meanings
638
- </code></pre>
639
- <h2>File Organization</h2>
640
- <h3>Directory Structure</h3>
641
- <pre><code>doc-builder/
642
- ├── README.md # Project overview
643
- ├── CHANGELOG.md # Version history
644
- ├── CLAUDE.md # AI assistant guide
645
- ├── DOCUMENT-STANDARDS.md # This file
646
- ├── docs/ # Additional documentation
647
- │ ├── guides/ # How-to guides
648
- │ ├── api/ # API documentation
649
- │ ├── architecture/ # System design docs
650
- │ └── troubleshooting/ # Problem-solving guides
651
- </code></pre>
652
- <h3>File Management</h3>
653
- <ul>
654
- <li>Keep active documentation in appropriate directories</li>
655
- <li>Archive outdated docs with date suffix: <code>old-guide-2025-01-15.md</code></li>
656
- <li>Remove unused files after archiving</li>
657
- <li>Maintain README.md in each directory explaining contents</li>
658
- </ul>
659
- <h2>Special Considerations</h2>
660
- <h3>Security</h3>
661
- <ul>
662
- <li>Never include credentials or API keys</li>
663
- <li>Use placeholders for sensitive data: <code>API_KEY=&lt;your-api-key-here&gt;</code></li>
664
- <li>Document security implications</li>
665
- <li>Include security warnings where relevant</li>
666
- </ul>
667
- <h3>Performance</h3>
668
- <ul>
669
- <li>Document performance characteristics</li>
670
- <li>Include benchmarks where applicable</li>
671
- <li>Note resource requirements</li>
672
- <li>Provide optimization tips</li>
673
- </ul>
674
- <h3>Accessibility</h3>
675
- <ul>
676
- <li>Use clear, simple language</li>
677
- <li>Provide alt text for images</li>
678
- <li>Structure documents logically</li>
679
- <li>Consider screen reader users</li>
680
- </ul>
681
- <h2>Document Maintenance</h2>
682
- <h3>Review Schedule</h3>
683
- <ul>
684
- <li>Technical docs: Review with each minor version</li>
685
- <li>API docs: Review with any API change</li>
686
- <li>Guides: Review quarterly</li>
687
- <li>README: Update with significant changes</li>
688
- </ul>
689
- <h3>Update Process</h3>
690
- <ol>
691
- <li>Check document metadata</li>
692
- <li>Verify technical accuracy</li>
693
- <li>Update examples</li>
694
- <li>Test code snippets</li>
695
- <li>Update changelog</li>
696
- <li>Commit with descriptive message</li>
697
- </ol>
698
- <h3>Document History</h3>
699
- <p>Include at the bottom of long-lived documents:</p>
700
- <pre><code class="language-markdown">## Document History
701
-
702
- | Date | Version | Author | Changes |
703
- |------|---------|--------|---------|
704
- | 2025-07-21 | 1.0 | System | Initial creation |
705
- | 2025-07-22 | 1.1 | Dev | Added examples |
706
- </code></pre>
707
- <h2>Tools and Automation</h2>
708
- <h3>Building Documentation</h3>
709
- <p>The doc-builder automatically:</p>
710
- <ul>
711
- <li>Generates navigation from folder structure</li>
712
- <li>Extracts summaries for tooltips</li>
713
- <li>Renders mermaid diagrams</li>
714
- <li>Applies syntax highlighting</li>
715
- <li>Creates responsive layouts</li>
716
- </ul>
717
- <h3>Preview Changes</h3>
718
- <pre><code class="language-bash"># Preview documentation locally
719
- npx doc-builder dev
720
-
721
- # Build and check output
722
- npx doc-builder build
723
- open html/index.html
724
- </code></pre>
725
- <h2>Conclusion</h2>
726
- <p>Following these standards ensures:</p>
727
- <ul>
728
- <li>Consistent, professional documentation</li>
729
- <li>Easy navigation and discovery</li>
730
- <li>Clear communication of technical concepts</li>
731
- <li>Maintainable documentation over time</li>
732
- </ul>
733
- <p>Remember: Good documentation is as important as good code. It enables others (including your future self) to understand, use, and maintain the project effectively.</p>
734
- <hr>
735
- <h2>Document History</h2>
736
- <table>
737
- <thead>
738
- <tr>
739
- <th>Date</th>
740
- <th>Version</th>
741
- <th>Author</th>
742
- <th>Changes</th>
743
- </tr>
744
- </thead>
745
- <tbody><tr>
746
- <td>2025-07-21</td>
747
- <td>1.0</td>
748
- <td>System</td>
749
- <td>Initial creation from project standards</td>
750
- </tr>
751
- </tbody></table>
752
-
753
- </div>
754
- </main>
755
- </div>
756
-
757
- <!-- Scripts -->
758
- <script>
759
- // Pass configuration to frontend
760
- window.docBuilderConfig = {
761
- features: {
762
- showPdfDownload: true,
763
- menuDefaultOpen: false,
764
- mermaidEnhanced: true
765
- }
766
- };
767
- </script>
768
- <script src="../js/main.js"></script>
769
-
770
- </body>
771
- </html>