@knowcode/doc-builder 1.9.30 → 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 (196) hide show
  1. package/package.json +12 -2
  2. package/.claude/settings.local.json +0 -56
  3. package/CACHE-BUSTING-GUIDE.md +0 -82
  4. package/CLAUDE.md +0 -86
  5. package/CONTRIBUTING.md +0 -148
  6. package/GITHUB_SETUP.md +0 -203
  7. package/RELEASE-NOTES-1.7.5.md +0 -64
  8. package/Screenshot 2025-07-22 at 19.51.21.png +0 -0
  9. package/Screenshot 2025-07-26 at 17.06.49.png +0 -0
  10. package/add-user-clive.sql +0 -35
  11. package/add-user-lindsay-fixed.sql +0 -85
  12. package/add-user-lindsay.sql +0 -68
  13. package/add-user-pmorgan.sql +0 -35
  14. package/add-user-robbie.sql +0 -35
  15. package/add-wru-users.sql +0 -105
  16. package/debug-login.sql +0 -30
  17. package/doc-builder.config.js +0 -126
  18. package/doc-builder.config.js.backup.1753793768283 +0 -47
  19. package/doc-builder.config.js.backup.1753803964423 +0 -114
  20. package/doc-builder.config.js.backup.1753945707032 +0 -115
  21. package/doc-builder.config.js.backup.1754059241330 +0 -115
  22. package/doc-builder.config.js.backup.1754119567787 +0 -123
  23. package/doc-builder.config.js.backup.1754120048862 +0 -124
  24. package/doc-builder.config.js.backup.1754120529913 +0 -124
  25. package/doc-builder.config.js.backup.1754218469785 +0 -124
  26. package/doc-builder.config.js.backup.1754384764054 +0 -124
  27. package/doc-builder.config.js.backup.1754567425847 +0 -124
  28. package/doc-builder.config.js.backup.1754568137859 +0 -126
  29. package/doc-builder.config.js.backup.1754569388252 +0 -126
  30. package/doc-builder.config.js.backup.1754576694123 +0 -126
  31. package/doc-builder.config.js.backup.1755031374829 +0 -126
  32. package/doc-builder.config.js.backup.1755034500990 +0 -126
  33. package/doc-builder.config.js.backup.1755034809236 +0 -126
  34. package/grant-access.sql +0 -15
  35. package/html/11.png +0 -0
  36. package/html/404.html +0 -115
  37. package/html/README.html +0 -522
  38. package/html/Screenshot 2025-08-12 at 21.35.07.png +0 -0
  39. package/html/about-doc-builder.html +0 -491
  40. package/html/auth.js +0 -157
  41. package/html/claude-workflow-guide.html +0 -525
  42. package/html/css/notion-style.css +0 -2502
  43. package/html/documentation-index.html +0 -471
  44. package/html/guides/authentication-default-change.html +0 -370
  45. package/html/guides/authentication-guide.html +0 -509
  46. package/html/guides/cache-control-anti-pattern.html +0 -361
  47. package/html/guides/claude-workflow-guide.html +0 -1074
  48. package/html/guides/configuration-guide.html +0 -472
  49. package/html/guides/document-standards.html +0 -518
  50. package/html/guides/documentation-standards.html +0 -694
  51. package/html/guides/html-embedding-guide.html +0 -461
  52. package/html/guides/image-modal-guide.html +0 -515
  53. package/html/guides/next-steps-walkthrough.html +0 -638
  54. package/html/guides/phosphor-icons-guide.html +0 -584
  55. package/html/guides/private-directory-authentication-troubleshooting.html +0 -555
  56. package/html/guides/private-directory-authentication.html +0 -541
  57. package/html/guides/public-site-deployment.html +0 -431
  58. package/html/guides/search-engine-verification-guide.html +0 -542
  59. package/html/guides/seo-guide.html +0 -661
  60. package/html/guides/seo-optimization-guide.html +0 -887
  61. package/html/guides/supabase-auth-implementation-plan.html +0 -543
  62. package/html/guides/supabase-auth-integration-plan.html +0 -671
  63. package/html/guides/supabase-auth-setup-guide.html +0 -498
  64. package/html/guides/supabase-authentication-complete-guide.html +0 -866
  65. package/html/guides/troubleshooting-guide.html +0 -633
  66. package/html/guides/vercel-deployment-auth-setup.html +0 -337
  67. package/html/guides/windows-setup-guide.html +0 -859
  68. package/html/image-modal-test.html +0 -318
  69. package/html/index.html +0 -522
  70. package/html/js/auth.js +0 -157
  71. package/html/js/main.js +0 -1754
  72. package/html/launch/README.html +0 -297
  73. package/html/launch/bubble-plugin-specification.html +0 -933
  74. package/html/launch/go-to-market-strategy.html +0 -663
  75. package/html/launch/launch-announcements.html +0 -593
  76. package/html/login.html +0 -102
  77. package/html/logout.html +0 -18
  78. package/html/private/cache-control-anti-pattern.html +0 -429
  79. package/html/private/launch/README.html +0 -371
  80. package/html/private/launch/auth-cleanup-summary.html +0 -361
  81. package/html/private/launch/bubble-plugin-specification.html +0 -1007
  82. package/html/private/launch/go-to-market-strategy.html +0 -737
  83. package/html/private/launch/launch-announcements.html +0 -667
  84. package/html/private/launch/vercel-deployment-auth-setup.html +0 -417
  85. package/html/private/next-steps-walkthrough.html +0 -679
  86. package/html/private/supabase-auth-implementation-completed.html +0 -454
  87. package/html/private/supabase-auth-implementation-plan.html +0 -594
  88. package/html/private/supabase-auth-integration-plan.html +0 -704
  89. package/html/private/supabase-auth-setup-guide.html +0 -555
  90. package/html/private/test-private-doc.html +0 -302
  91. package/html/private/user-management-tooling.html +0 -601
  92. package/html/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
  93. package/html/prompts/beautiful-documentation-design.html +0 -784
  94. package/html/prompts/markdown-document-standards.html +0 -422
  95. package/html/prompts/project-rename-strategy-sasha-publish.html +0 -530
  96. package/html/robots.txt +0 -9
  97. package/html/sitemap.xml +0 -357
  98. package/html/test-questions/how-does-it-work%3F.html +0 -294
  99. package/html/test-questions/step-1%3A%20getting-started.html +0 -289
  100. package/html/test-questions/what-is-the-purpose.html +0 -293
  101. package/html/test-status.html +0 -281
  102. package/html/vercel-cli-setup-guide.html +0 -495
  103. package/html/vercel-first-time-setup-guide.html +0 -454
  104. package/html/vercel.json +0 -29
  105. package/html-static/11.png +0 -0
  106. package/html-static/404.html +0 -115
  107. package/html-static/README.html +0 -609
  108. package/html-static/Screenshot 2025-08-12 at 21.35.07.png +0 -0
  109. package/html-static/about-doc-builder.html +0 -578
  110. package/html-static/css/notion-style.css +0 -2502
  111. package/html-static/documentation-index.html +0 -558
  112. package/html-static/guides/authentication-default-change.html +0 -457
  113. package/html-static/guides/authentication-guide.html +0 -596
  114. package/html-static/guides/claude-workflow-guide.html +0 -1161
  115. package/html-static/guides/configuration-guide.html +0 -559
  116. package/html-static/guides/documentation-standards.html +0 -781
  117. package/html-static/guides/html-embedding-guide.html +0 -548
  118. package/html-static/guides/image-modal-guide.html +0 -602
  119. package/html-static/guides/phosphor-icons-guide.html +0 -671
  120. package/html-static/guides/private-directory-authentication-troubleshooting.html +0 -642
  121. package/html-static/guides/private-directory-authentication.html +0 -628
  122. package/html-static/guides/public-site-deployment.html +0 -518
  123. package/html-static/guides/search-engine-verification-guide.html +0 -629
  124. package/html-static/guides/seo-guide.html +0 -748
  125. package/html-static/guides/seo-optimization-guide.html +0 -974
  126. package/html-static/guides/supabase-authentication-complete-guide.html +0 -953
  127. package/html-static/guides/troubleshooting-guide.html +0 -720
  128. package/html-static/guides/windows-setup-guide.html +0 -946
  129. package/html-static/image-modal-test.html +0 -405
  130. package/html-static/index.html +0 -609
  131. package/html-static/js/main.js +0 -1754
  132. package/html-static/prompts/Screenshot 2025-08-02 at 08.49.55.png +0 -0
  133. package/html-static/prompts/beautiful-documentation-design.html +0 -871
  134. package/html-static/prompts/markdown-document-standards.html +0 -509
  135. package/html-static/prompts/project-rename-strategy-sasha-publish.html +0 -617
  136. package/html-static/robots.txt +0 -5
  137. package/html-static/sitemap.xml +0 -195
  138. package/html-static/test-questions/how-does-it-work%3F.html +0 -381
  139. package/html-static/test-questions/step-1%3A%20getting-started.html +0 -376
  140. package/html-static/test-questions/what-is-the-purpose.html +0 -380
  141. package/html-static/vercel-cli-setup-guide.html +0 -582
  142. package/html-static/vercel-first-time-setup-guide.html +0 -541
  143. package/manage-users.sql +0 -191
  144. package/migrate-to-domain-auth.sql +0 -47
  145. package/package/CACHE-BUSTING-GUIDE.md +0 -82
  146. package/package/CHANGELOG.md +0 -902
  147. package/package/README.md +0 -248
  148. package/package/assets/css/notion-style.css +0 -2211
  149. package/package/assets/js/auth.js +0 -67
  150. package/package/assets/js/main.js +0 -1565
  151. package/package/cli.js +0 -764
  152. package/package/index.js +0 -38
  153. package/package/knowcode-doc-builder-1.3.15.tgz +0 -0
  154. package/package/lib/builder.js +0 -32
  155. package/package/lib/config.js +0 -278
  156. package/package/lib/core-builder.js +0 -957
  157. package/package/lib/deploy.js +0 -497
  158. package/package/lib/dev-server.js +0 -96
  159. package/package/package.json +0 -34
  160. package/package/scripts/npx-runner.js +0 -27
  161. package/package/scripts/setup.js +0 -56
  162. package/package/test-cache-bust.sh +0 -43
  163. package/public-config.js +0 -22
  164. package/public-html/404.html +0 -115
  165. package/public-html/README.html +0 -149
  166. package/public-html/css/notion-style.css +0 -2036
  167. package/public-html/index.html +0 -149
  168. package/public-html/js/auth.js +0 -67
  169. package/public-html/js/main.js +0 -1485
  170. package/quick-test-commands.md +0 -40
  171. package/recordings/Screenshot 2025-07-24 at 18.22.01.png +0 -0
  172. package/recordings/mh-ls-22jul.txt +0 -2305
  173. package/screenshot.png +0 -0
  174. package/scripts/Screenshot 2025-07-23 at 15.39.41.png +0 -0
  175. package/setup-database-v2.sql +0 -53
  176. package/setup-database.sql +0 -41
  177. package/test-auth-config.js +0 -17
  178. package/test-cache-bust.sh +0 -43
  179. package/test-docs/README.md +0 -39
  180. package/test-html/404.html +0 -115
  181. package/test-html/README.html +0 -172
  182. package/test-html/auth.js +0 -97
  183. package/test-html/css/notion-style.css +0 -2036
  184. package/test-html/index.html +0 -172
  185. package/test-html/js/auth.js +0 -97
  186. package/test-html/js/main.js +0 -1485
  187. package/test-html/login.html +0 -102
  188. package/test-html/logout.html +0 -18
  189. package/update-domain.sql +0 -9
  190. package/user-access-view.sql +0 -49
  191. package/user-management/README.md +0 -301
  192. package/user-management/add-users.sh +0 -776
  193. package/user-management/create-user.js +0 -65
  194. package/user-management/users.txt +0 -15
  195. package/view-all-users.sql +0 -40
  196. package/wru-auth-config.js +0 -17
@@ -1,638 +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="Now that we&#039;ve implemented Supabase authentication, let&#039;s walk through testing the implementation and preparing for deployment. This guide provides detailed,...">
7
- <title>Next Steps: Testing and Deployment Walkthrough</title>
8
-
9
- <meta name="author" content="Lindsay Smith">
10
- <meta name="keywords" content="documentation, markdown, static site generator, vercel, notion-style, test, step">
11
- <meta name="robots" content="index, follow">
12
- <link rel="canonical" href="https://doc-builder-delta.vercel.app/guides/next-steps-walkthrough.html">
13
-
14
- <!-- Open Graph / Facebook -->
15
- <meta property="og:type" content="article">
16
- <meta property="og:url" content="https://doc-builder-delta.vercel.app/guides/next-steps-walkthrough.html">
17
- <meta property="og:title" content="Next Steps: Testing and Deployment Walkthrough">
18
- <meta property="og:description" content="Now that we&#39;ve implemented Supabase authentication, let&#39;s walk through testing the implementation and preparing for deployment. This guide provides detailed,...">
19
- <meta property="og:image" content="https://doc-builder-delta.vercel.app/og-default.png">
20
- <meta property="og:site_name" content="@knowcode/doc-builder">
21
- <meta property="og:locale" content="en_US">
22
-
23
- <!-- Twitter Card -->
24
- <meta name="twitter:card" content="summary_large_image">
25
- <meta name="twitter:site" content="@planbbackups">
26
- <meta name="twitter:creator" content="@planbbackups">
27
- <meta name="twitter:title" content="Next Steps: Testing and Deployment Walkthrough">
28
- <meta name="twitter:description" content="Now that we&#39;ve implemented Supabase authentication, let&#39;s walk through testing the implementation and preparing for deployment. This guide provides detailed,...">
29
- <meta name="twitter:image" content="https://doc-builder-delta.vercel.app/og-default.png">
30
-
31
- <!-- Custom Meta Tags -->
32
- <meta name="google-site-verification" content="FtzcDTf5BQ9K5EfnGazQkgU2U4FiN3ITzM7gHwqUAqQ">
33
- <meta name="msvalidate.01" content="B2D8C4C12C530D47AA962B24CAA09630">
34
-
35
- <!-- Fonts -->
36
- <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
37
-
38
- <!-- Icons -->
39
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
40
- <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@phosphor-icons/web@2.1.1/src/regular/style.css">
41
-
42
- <!-- Mermaid -->
43
- <script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
44
-
45
- <!-- Styles -->
46
- <link rel="stylesheet" href="/css/notion-style.css">
47
-
48
-
49
-
50
- <!-- Favicon -->
51
- <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>">
52
-
53
- <script type="application/ld+json">
54
- {
55
- "@context": "https://schema.org",
56
- "@type": "TechArticle",
57
- "headline": "Next Steps: Testing and Deployment Walkthrough",
58
- "description": "Now that we've implemented Supabase authentication, let's walk through testing the implementation and preparing for deployment. This guide provides detailed,...",
59
- "author": {
60
- "@type": "Person",
61
- "name": "Lindsay Smith"
62
- },
63
- "publisher": {
64
- "@type": "Organization",
65
- "name": "Knowcode Ltd",
66
- "url": "https://knowcode.tech"
67
- },
68
- "datePublished": "2025-07-25T13:49:06.533Z",
69
- "dateModified": "2025-07-25T13:49:06.533Z",
70
- "mainEntityOfPage": {
71
- "@type": "WebPage",
72
- "@id": "https://doc-builder-delta.vercel.app/guides/next-steps-walkthrough.html"
73
- },
74
- "breadcrumb": {
75
- "@type": "BreadcrumbList",
76
- "itemListElement": [
77
- {
78
- "@type": "ListItem",
79
- "position": 1,
80
- "name": "@knowcode/doc-builder",
81
- "item": "https://doc-builder-delta.vercel.app"
82
- },
83
- {
84
- "@type": "ListItem",
85
- "position": 2,
86
- "name": "Guides",
87
- "item": "https://doc-builder-delta.vercel.app/guides/"
88
- },
89
- {
90
- "@type": "ListItem",
91
- "position": 3,
92
- "name": "Next Steps Walkthrough",
93
- "item": "https://doc-builder-delta.vercel.app/guides/next-steps-walkthrough.html"
94
- }
95
- ]
96
- }
97
- }
98
- </script>
99
- </head>
100
- <body>
101
- <!-- Header -->
102
- <header class="header">
103
- <div class="header-content">
104
- <a href="/index.html" class="logo">@knowcode/doc-builder</a>
105
-
106
- <div class="header-actions">
107
- <div class="deployment-info">
108
- <span class="deployment-date" title="Built with doc-builder v1.7.5">Last updated: Jul 25, 2025, 01:49 PM UTC</span>
109
- </div>
110
-
111
-
112
-
113
- <button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
114
- <i class="fas fa-moon"></i>
115
- </button>
116
-
117
- <button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
118
- <i class="fas fa-bars"></i>
119
- </button>
120
- </div>
121
- </div>
122
- </header>
123
-
124
- <!-- Preview Banner -->
125
- <div id="preview-banner" class="preview-banner">
126
- <div class="banner-content">
127
- <i class="fas fa-exclamation-triangle banner-icon"></i>
128
- <span class="banner-text">This documentation is a preview version - some content may be incomplete</span>
129
- <button id="dismiss-banner" class="banner-dismiss" aria-label="Dismiss banner">
130
- <i class="fas fa-times"></i>
131
- </button>
132
- </div>
133
- </div>
134
-
135
- <!-- Breadcrumbs -->
136
- <nav class="breadcrumbs" id="breadcrumbs">
137
- <!-- Breadcrumbs will be generated by JavaScript -->
138
- </nav>
139
-
140
- <!-- Main Content -->
141
- <div class="main-wrapper">
142
- <!-- Sidebar -->
143
- <aside class="sidebar">
144
- <div class="sidebar-header">
145
- <div class="filter-box">
146
- <input type="text" placeholder="Filter items..." class="filter-input" id="nav-filter">
147
- <i class="fas fa-search filter-icon"></i>
148
- </div>
149
- </div>
150
- <nav class="navigation">
151
-
152
- <div class="nav-section" data-level="0">
153
- <a class="nav-title" href="/README.html" >
154
- <i class="fas fa-home"></i> Documentation
155
- </a>
156
- <div class="nav-content" >
157
- <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
158
- <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="fas fa-file-alt"></i> Documentation Index</a>
159
- <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="fas fa-file-alt"></i> Vercel Cli Setup Guide</a>
160
- <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="fas fa-file-alt"></i> Vercel First Time Setup Guide</a></div></div>
161
- <div class="nav-section" data-level="1">
162
- <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
163
- <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
164
- </a>
165
- <div class="nav-content" id="nav-guides-1">
166
- <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="fas fa-file-alt"></i> Authentication Default Change</a>
167
- <a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="🚨 This authentication method has been REMOVED in version 2.0.0 due to serious security flaws."><i class="fas fa-file-alt"></i> Authentication Guide</a>
168
- <a href="/guides/cache-control-anti-pattern.html" class="nav-item" data-tooltip="Cache Control Anti-Pattern: Why Aggressive Cache-Busting is Bad for Documentation Sites."><i class="fas fa-file-alt"></i> Cache Control Anti Pattern</a>
169
- <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="fas fa-file-alt"></i> Claude Workflow Guide</a>
170
- <a href="/guides/documentation-standards.html" class="nav-item" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> Documentation Standards</a>
171
- <a href="/guides/next-steps-walkthrough.html" class="nav-item active" data-tooltip="Now that we&#039;ve implemented Supabase authentication, let&#039;s walk through testing the implementation and preparing for deployment."><i class="fas fa-file-alt"></i> Next Steps Walkthrough</a>
172
- <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="fas fa-file-alt"></i> Phosphor Icons Guide</a>
173
- <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="fas fa-file-alt"></i> Public Site Deployment</a>
174
- <a href="/guides/search-engine-verification-guide.html" class="nav-item" data-tooltip="Search engine verification provides access to powerful webmaster tools:."><i class="fas fa-file-alt"></i> Search Engine Verification Guide</a>
175
- <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="fas fa-file-alt"></i> Seo Guide</a>
176
- <a href="/guides/seo-optimization-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder includes comprehensive SEO (Search Engine Optimization) features that automatically optimize your documentation for search..."><i class="fas fa-file-alt"></i> Seo Optimization Guide</a>
177
- <a href="/guides/supabase-auth-implementation-plan.html" class="nav-item" data-tooltip="Supabase Auth Implementation Plan for @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Supabase Auth Implementation Plan</a>
178
- <a href="/guides/supabase-auth-integration-plan.html" class="nav-item" data-tooltip="Supabase Authentication Integration Plan for @knowcode/doc-builder."><i class="fas fa-file-alt"></i> Supabase Auth Integration Plan</a>
179
- <a href="/guides/supabase-auth-setup-guide.html" class="nav-item" data-tooltip="@knowcode/doc-builder now supports enterprise-grade authentication through Supabase, replacing the previous insecure basic authentication."><i class="fas fa-file-alt"></i> Supabase Auth Setup Guide</a>
180
- <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="fas fa-file-alt"></i> Troubleshooting Guide</a>
181
- <a href="/guides/vercel-deployment-auth-setup.html" class="nav-item" data-tooltip="Vercel Deployment Authentication Setup Guide."><i class="fas fa-file-alt"></i> Vercel Deployment Auth Setup</a>
182
- <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="fas fa-file-alt"></i> Windows Setup Guide</a></div></div>
183
- <div class="nav-section" data-level="1">
184
- <a class="nav-title collapsible" href="/launch/README.html" data-target="nav-launch-1" >
185
- <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Launch
186
- </a>
187
- <div class="nav-content collapsed" id="nav-launch-1">
188
- <a href="/launch/README.html" class="nav-item" data-tooltip="This directory contains all documentation related to the commercial launch of @knowcode/doc-builder, including go-to-market strategy, platform..."><i class="fas fa-file-alt"></i> Launch Overview</a>
189
- <a href="/launch/bubble-plugin-specification.html" class="nav-item" data-tooltip="This document outlines the technical specification for creating a Bubble.io plugin that integrates @knowcode/doc-builder, enabling Bubble developers..."><i class="fas fa-file-alt"></i> Bubble Plugin Specification</a>
190
- <a href="/launch/go-to-market-strategy.html" class="nav-item" data-tooltip="Go-to-Market Strategy &amp; Product Launch Plan."><i class="fas fa-file-alt"></i> Go To Market Strategy</a>
191
- <a href="/launch/launch-announcements.html" class="nav-item" data-tooltip="This document contains ready-to-use announcement templates for launching @knowcode/doc-builder across various platforms and channels."><i class="fas fa-file-alt"></i> Launch Announcements</a></div></div>
192
- </nav>
193
- <div class="resize-handle"></div>
194
- </aside>
195
-
196
- <!-- Content Area -->
197
- <main class="content">
198
- <div class="content-inner">
199
- <h1>Next Steps: Testing and Deployment Walkthrough</h1>
200
- <h2>Overview</h2>
201
- <p>Now that we&#39;ve implemented Supabase authentication, let&#39;s walk through testing the implementation and preparing for deployment. This guide provides detailed, step-by-step instructions.</p>
202
- <h2>🧪 Phase 1: Local Testing</h2>
203
- <h3>Step 1: Install Dependencies</h3>
204
- <p>First, install the new Supabase dependency:</p>
205
- <pre><code class="language-bash">cd /Users/lindsaysmith/Documents/lambda1.nosync/doc-builder
206
- npm install
207
- </code></pre>
208
- <h3>Step 2: Set Up Test Supabase Project</h3>
209
- <ol>
210
- <li><strong>Go to Supabase</strong>: Visit <a href="https://app.supabase.com">app.supabase.com</a></li>
211
- <li><strong>Create new project</strong>: <ul>
212
- <li>Name: <code>doc-builder-test</code></li>
213
- <li>Database password: Choose a secure password</li>
214
- <li>Region: Choose closest to you</li>
215
- </ul>
216
- </li>
217
- <li><strong>Wait for setup</strong>: Usually takes 1-2 minutes</li>
218
- </ol>
219
- <h3>Step 3: Create Database Tables</h3>
220
- <ol>
221
- <li><strong>Go to SQL Editor</strong> in Supabase dashboard</li>
222
- <li><strong>Run this SQL</strong> to create the required tables:</li>
223
- </ol>
224
- <pre><code class="language-sql">-- Table 1: Documentation sites
225
- CREATE TABLE docbuilder_sites (
226
- id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
227
- domain TEXT UNIQUE NOT NULL,
228
- name TEXT NOT NULL,
229
- created_at TIMESTAMPTZ DEFAULT NOW()
230
- );
231
-
232
- -- Table 2: User access mapping
233
- CREATE TABLE docbuilder_access (
234
- user_id UUID REFERENCES auth.users(id) ON DELETE CASCADE,
235
- site_id UUID REFERENCES docbuilder_sites(id) ON DELETE CASCADE,
236
- created_at TIMESTAMPTZ DEFAULT NOW(),
237
- PRIMARY KEY (user_id, site_id)
238
- );
239
-
240
- -- Enable Row Level Security
241
- ALTER TABLE docbuilder_sites ENABLE ROW LEVEL SECURITY;
242
- ALTER TABLE docbuilder_access ENABLE ROW LEVEL SECURITY;
243
-
244
- -- RLS Policy: Users can only see sites they have access to
245
- CREATE POLICY &quot;Users see accessible sites&quot; ON docbuilder_sites
246
- FOR SELECT USING (
247
- EXISTS (
248
- SELECT 1 FROM docbuilder_access
249
- WHERE site_id = docbuilder_sites.id
250
- AND user_id = auth.uid()
251
- )
252
- );
253
-
254
- -- RLS Policy: Users can see their own access
255
- CREATE POLICY &quot;Users see own access&quot; ON docbuilder_access
256
- FOR SELECT USING (user_id = auth.uid());
257
- </code></pre>
258
- <h3>Step 4: Get Supabase Credentials</h3>
259
- <ol>
260
- <li><strong>Go to Settings → API</strong> in Supabase dashboard</li>
261
- <li><strong>Copy these values</strong>:<ul>
262
- <li>Project URL (e.g., <code>https://abc123.supabase.co</code>)</li>
263
- <li>Anon public key (starts with <code>eyJ...</code>)</li>
264
- </ul>
265
- </li>
266
- </ol>
267
- <h3>Step 5: Create Test Configuration</h3>
268
- <ol>
269
- <li><strong>Create test config file</strong>:</li>
270
- </ol>
271
- <pre><code class="language-bash"># In the doc-builder directory
272
- cat &gt; test-config.js &lt;&lt; &#39;EOF&#39;
273
- module.exports = {
274
- siteName: &#39;Test Documentation&#39;,
275
-
276
- features: {
277
- authentication: &#39;supabase&#39;
278
- },
279
-
280
- auth: {
281
- supabaseUrl: &#39;YOUR_SUPABASE_URL_HERE&#39;,
282
- supabaseAnonKey: &#39;YOUR_ANON_KEY_HERE&#39;,
283
- siteId: &#39;&#39; // Will be filled in next step
284
- }
285
- };
286
- EOF
287
- </code></pre>
288
- <ol start="2">
289
- <li><strong>Replace the placeholders</strong> with your actual Supabase credentials</li>
290
- </ol>
291
- <h3>Step 6: Test the CLI Commands</h3>
292
- <ol>
293
- <li><strong>Test the auth:init command</strong>:</li>
294
- </ol>
295
- <pre><code class="language-bash">node cli.js auth:init --config test-config.js
296
- </code></pre>
297
- <p>This should prompt you for Supabase credentials and create/update the config.</p>
298
- <ol start="2">
299
- <li><strong>Add a test site to database</strong>:</li>
300
- </ol>
301
- <pre><code class="language-sql">-- Run in Supabase SQL Editor
302
- INSERT INTO docbuilder_sites (domain, name)
303
- VALUES (&#39;localhost:3000&#39;, &#39;Test Site&#39;)
304
- RETURNING id;
305
- </code></pre>
306
- <ol start="3">
307
- <li><strong>Copy the returned site ID</strong> and update your <code>test-config.js</code>:</li>
308
- </ol>
309
- <pre><code class="language-javascript">siteId: &#39;the-uuid-returned-from-above&#39;
310
- </code></pre>
311
- <h3>Step 7: Create Test Documentation</h3>
312
- <ol>
313
- <li><strong>Create test docs folder</strong>:</li>
314
- </ol>
315
- <pre><code class="language-bash">mkdir -p test-docs
316
- echo &quot;# Test Documentation
317
-
318
- This is a test page for Supabase authentication.
319
-
320
- ## Features
321
-
322
- - Secure login with Supabase
323
- - User access control
324
- - Session management
325
-
326
- If you can see this page, authentication is working!&quot; &gt; test-docs/README.md
327
- </code></pre>
328
- <h3>Step 8: Test Build Process</h3>
329
- <ol>
330
- <li><strong>Build with authentication</strong>:</li>
331
- </ol>
332
- <pre><code class="language-bash">node cli.js build --config test-config.js --input test-docs --output test-html
333
- </code></pre>
334
- <ol start="2">
335
- <li><strong>Check for expected files</strong>:</li>
336
- </ol>
337
- <pre><code class="language-bash">ls -la test-html/
338
- # Should see:
339
- # - login.html
340
- # - logout.html
341
- # - js/auth.js
342
- # - index.html
343
- </code></pre>
344
- <ol start="3">
345
- <li><strong>Inspect generated auth script</strong>:</li>
346
- </ol>
347
- <pre><code class="language-bash">head -20 test-html/js/auth.js
348
- # Should show Supabase integration code, not basic auth
349
- </code></pre>
350
- <h3>Step 9: Test Local Server</h3>
351
- <ol>
352
- <li><strong>Start development server</strong>:</li>
353
- </ol>
354
- <pre><code class="language-bash">node cli.js dev --config test-config.js --input test-docs --port 3001
355
- </code></pre>
356
- <ol start="2">
357
- <li><strong>Open browser</strong> to <code>http://localhost:3001</code></li>
358
- <li><strong>Expected behavior</strong>:<ul>
359
- <li>Should redirect to <code>/login.html</code> </li>
360
- <li>Login page should show email/password fields</li>
361
- <li>Should show Supabase errors (no user exists yet)</li>
362
- </ul>
363
- </li>
364
- </ol>
365
- <h3>Step 10: Create Test User</h3>
366
- <ol>
367
- <li><strong>In Supabase dashboard</strong>, go to <strong>Authentication → Users</strong></li>
368
- <li><strong>Click &quot;Add User&quot;</strong>:<ul>
369
- <li>Email: <code>test@example.com</code></li>
370
- <li>Password: <code>testpassword123</code></li>
371
- <li>Email confirm: <code>true</code></li>
372
- </ul>
373
- </li>
374
- <li><strong>Get the user ID</strong> from the users table</li>
375
- </ol>
376
- <h3>Step 11: Grant Access to Test User</h3>
377
- <pre><code class="language-sql">-- Run in Supabase SQL Editor
378
- -- Replace with actual user ID and site ID
379
- INSERT INTO docbuilder_access (user_id, site_id)
380
- VALUES (&#39;USER_ID_FROM_STEP_10&#39;, &#39;SITE_ID_FROM_STEP_6&#39;);
381
- </code></pre>
382
- <h3>Step 12: Test Complete Flow</h3>
383
- <ol>
384
- <li><strong>Go to</strong> <code>http://localhost:3001</code></li>
385
- <li><strong>Should redirect to login</strong></li>
386
- <li><strong>Login with</strong>:<ul>
387
- <li>Email: <code>test@example.com</code></li>
388
- <li>Password: <code>testpassword123</code></li>
389
- </ul>
390
- </li>
391
- <li><strong>Should redirect to documentation</strong></li>
392
- <li><strong>Should see the test content</strong></li>
393
- <li><strong>Logout should work</strong></li>
394
- </ol>
395
- <h2><i class="ph ph-rocket-launch" aria-label="launch"></i> Phase 2: Deployment Testing</h2>
396
- <h3>Step 13: Test Vercel Deployment</h3>
397
- <ol>
398
- <li><strong>Update config for deployment</strong>:</li>
399
- </ol>
400
- <pre><code class="language-javascript">// test-config.js
401
- module.exports = {
402
- siteName: &#39;Test Documentation&#39;,
403
-
404
- features: {
405
- authentication: &#39;supabase&#39;
406
- },
407
-
408
- auth: {
409
- supabaseUrl: process.env.SUPABASE_URL || &#39;your-fallback-url&#39;,
410
- supabaseAnonKey: process.env.SUPABASE_ANON_KEY || &#39;your-fallback-key&#39;,
411
- siteId: process.env.DOC_SITE_ID || &#39;your-site-id&#39;
412
- }
413
- };
414
- </code></pre>
415
- <ol start="2">
416
- <li><strong>Create environment file</strong> for local testing:</li>
417
- </ol>
418
- <pre><code class="language-bash">cat &gt; .env &lt;&lt; &#39;EOF&#39;
419
- SUPABASE_URL=your-supabase-url
420
- SUPABASE_ANON_KEY=your-anon-key
421
- DOC_SITE_ID=your-site-id
422
- EOF
423
- </code></pre>
424
- <ol start="3">
425
- <li><strong>Test with environment variables</strong>:</li>
426
- </ol>
427
- <pre><code class="language-bash">source .env
428
- node cli.js build --config test-config.js --input test-docs --output test-html
429
- </code></pre>
430
- <ol start="4">
431
- <li><strong>Deploy to Vercel</strong>:</li>
432
- </ol>
433
- <pre><code class="language-bash">node cli.js deploy --config test-config.js --input test-docs
434
- </code></pre>
435
- <ol start="5">
436
- <li><strong>Configure environment variables in Vercel</strong>:<ul>
437
- <li>Go to Vercel dashboard</li>
438
- <li>Find your project</li>
439
- <li>Go to Settings → Environment Variables</li>
440
- <li>Add: <code>SUPABASE_URL</code>, <code>SUPABASE_ANON_KEY</code>, <code>DOC_SITE_ID</code></li>
441
- </ul>
442
- </li>
443
- </ol>
444
- <h3>Step 14: Update Site Domain in Database</h3>
445
- <pre><code class="language-sql">-- Update the domain to match your Vercel URL
446
- UPDATE docbuilder_sites
447
- SET domain = &#39;your-vercel-url.vercel.app&#39;
448
- WHERE id = &#39;your-site-id&#39;;
449
- </code></pre>
450
- <h2><i class="ph ph-wrench" aria-label="settings"></i> Phase 3: Version Management</h2>
451
- <h3>Step 15: Update Version Number</h3>
452
- <ol>
453
- <li><strong>Update package.json</strong>:</li>
454
- </ol>
455
- <pre><code class="language-bash"># Current version is 1.7.4, bump to 2.0.0 for breaking changes
456
- npm version major
457
- </code></pre>
458
- <ol start="2">
459
- <li><strong>Update CHANGELOG.md</strong>:</li>
460
- </ol>
461
- <pre><code class="language-bash">cat &gt;&gt; CHANGELOG.md &lt;&lt; &#39;EOF&#39;
462
-
463
- ## [2.0.0] - 2025-07-25
464
-
465
- ### BREAKING CHANGES
466
- - **Removed insecure basic authentication** - All client-side credential checking has been removed for security
467
- - **Removed --no-auth CLI flag** - Use `authentication: false` in config instead
468
- - **Updated configuration format** - `auth` object now requires Supabase credentials
469
-
470
- ### Added
471
- - **Supabase authentication integration** - Enterprise-grade secure authentication
472
- - **Multi-site SSO support** - One account can access multiple documentation sites
473
- - **CLI authentication commands** - `auth:init`, `auth:add-site`, `auth:grant`, `auth:revoke`, `auth:list-users`
474
- - **Comprehensive setup guide** - Step-by-step Supabase authentication setup
475
- - **Environment variable support** - Better security for production deployments
476
-
477
- ### Security
478
- - **Fixed critical vulnerability** - Client-side credentials are no longer exposed in JavaScript
479
- - **Added Row Level Security** - Database-level access control
480
- - **JWT token authentication** - Industry-standard secure sessions
481
- - **Password hashing with bcrypt** - Secure password storage
482
- - **Built-in password reset** - Users can reset their own passwords
483
-
484
- ### Migration
485
- - See `docs/guides/supabase-auth-setup-guide.md` for migration instructions
486
- - Old basic auth configurations will need to be updated
487
- - Existing users will need to be migrated to Supabase
488
-
489
- EOF
490
- </code></pre>
491
- <h3>Step 16: Test Package Publishing</h3>
492
- <ol>
493
- <li><strong>Test pack command</strong>:</li>
494
- </ol>
495
- <pre><code class="language-bash">npm pack
496
- # This creates a .tgz file without publishing
497
- </code></pre>
498
- <ol start="2">
499
- <li><strong>Test installation from local package</strong>:</li>
500
- </ol>
501
- <pre><code class="language-bash"># In a different directory
502
- mkdir test-install
503
- cd test-install
504
- npm install ../doc-builder/*.tgz
505
-
506
- # Test the CLI
507
- npx doc-builder --version
508
- npx doc-builder --help
509
- </code></pre>
510
- <h2><i class="ph ph-clipboard-text" aria-label="clipboard"></i> Phase 4: Quality Assurance</h2>
511
- <h3>Step 17: Test All CLI Commands</h3>
512
- <pre><code class="language-bash"># Test help
513
- node cli.js --help
514
-
515
- # Test settings
516
- node cli.js settings --config test-config.js
517
-
518
- # Test each auth command
519
- node cli.js auth:init --help
520
- node cli.js auth:add-site --help
521
- node cli.js auth:grant --help
522
- node cli.js auth:revoke --help
523
- node cli.js auth:list-users --help
524
-
525
- # Test build with different options
526
- node cli.js build --config test-config.js
527
- node cli.js build --preset notion-inspired
528
- </code></pre>
529
- <h3>Step 18: Validate Generated Files</h3>
530
- <ol>
531
- <li><strong>Check authentication files</strong>:</li>
532
- </ol>
533
- <pre><code class="language-bash"># Should exist and contain Supabase code
534
- cat test-html/js/auth.js | grep -i supabase
535
- cat test-html/login.html | grep -i supabase
536
- cat test-html/logout.html | head -10
537
- </code></pre>
538
- <ol start="2">
539
- <li><strong>Check for security issues</strong>:</li>
540
- </ol>
541
- <pre><code class="language-bash"># Should NOT contain any hardcoded credentials
542
- grep -r &quot;password.*:&quot; test-html/ || echo &quot;Good - no hardcoded passwords&quot;
543
- grep -r &quot;username.*:&quot; test-html/ || echo &quot;Good - no hardcoded usernames&quot;
544
- </code></pre>
545
- <h3>Step 19: Cross-Platform Testing</h3>
546
- <p>If possible, test on different systems:</p>
547
- <ul>
548
- <li><strong>macOS</strong>: Current system <i class="ph ph-check-circle" aria-label="checked"></i></li>
549
- <li><strong>Windows</strong>: Test in WSL or Windows machine</li>
550
- <li><strong>Linux</strong>: Test in Docker or Linux VM</li>
551
- </ul>
552
- <h3>Step 20: Documentation Review</h3>
553
- <ol>
554
- <li><strong>Check all documentation links</strong>:</li>
555
- </ol>
556
- <pre><code class="language-bash"># Test that all internal links work
557
- find docs/ -name &quot;*.md&quot; -exec grep -l &quot;]\(&quot; {} \;
558
- </code></pre>
559
- <ol start="2">
560
- <li><strong>Validate setup guide</strong>:<ul>
561
- <li>Follow the setup guide from scratch</li>
562
- <li>Ensure all steps work as documented</li>
563
- <li>Check for missing steps or unclear instructions</li>
564
- </ul>
565
- </li>
566
- </ol>
567
- <h2><i class="ph ph-target" aria-label="goal"></i> Success Criteria Checklist</h2>
568
- <p>Before considering deployment ready:</p>
569
- <h3>Functionality</h3>
570
- <ul>
571
- <li><input disabled="" type="checkbox"> CLI auth commands work correctly</li>
572
- <li><input disabled="" type="checkbox"> Build process generates Supabase auth files</li>
573
- <li><input disabled="" type="checkbox"> Login/logout flow works end-to-end</li>
574
- <li><input disabled="" type="checkbox"> User access control functions properly</li>
575
- <li><input disabled="" type="checkbox"> Environment variables work in production</li>
576
- <li><input disabled="" type="checkbox"> Vercel deployment succeeds with auth</li>
577
- </ul>
578
- <h3>Security</h3>
579
- <ul>
580
- <li><input disabled="" type="checkbox"> No hardcoded credentials in generated files</li>
581
- <li><input disabled="" type="checkbox"> Row Level Security policies work</li>
582
- <li><input disabled="" type="checkbox"> JWT tokens are properly validated</li>
583
- <li><input disabled="" type="checkbox"> Session management is secure</li>
584
- <li><input disabled="" type="checkbox"> Password reset functionality works</li>
585
- </ul>
586
- <h3>Documentation</h3>
587
- <ul>
588
- <li><input disabled="" type="checkbox"> Setup guide is complete and accurate</li>
589
- <li><input disabled="" type="checkbox"> Migration instructions are clear</li>
590
- <li><input disabled="" type="checkbox"> CLI help text is updated</li>
591
- <li><input disabled="" type="checkbox"> README reflects new authentication</li>
592
- <li><input disabled="" type="checkbox"> Security warnings are prominent</li>
593
- </ul>
594
- <h3>Compatibility</h3>
595
- <ul>
596
- <li><input disabled="" type="checkbox"> Node.js 14+ compatibility maintained</li>
597
- <li><input disabled="" type="checkbox"> Vercel deployment works</li>
598
- <li><input disabled="" type="checkbox"> Environment variable support</li>
599
- <li><input disabled="" type="checkbox"> Cross-platform functionality</li>
600
- </ul>
601
- <h2><i class="ph ph-siren" aria-label="alert"></i> Issues to Watch For</h2>
602
- <h3>Common Problems</h3>
603
- <ol>
604
- <li><strong>Supabase URL format errors</strong> - Must be <code>https://xxx.supabase.co</code></li>
605
- <li><strong>RLS policy conflicts</strong> - May interfere with existing policies</li>
606
- <li><strong>JavaScript errors in browser</strong> - Check console for auth failures</li>
607
- <li><strong>Build failures</strong> - Missing Supabase credentials cause build errors</li>
608
- <li><strong>Environment variable issues</strong> - Vercel env vars not loading properly</li>
609
- </ol>
610
- <h3>Debugging Tips</h3>
611
- <ol>
612
- <li><strong>Check browser console</strong> for JavaScript errors</li>
613
- <li><strong>Verify Supabase credentials</strong> in dashboard</li>
614
- <li><strong>Test database queries</strong> directly in Supabase SQL editor</li>
615
- <li><strong>Check generated files</strong> contain expected Supabase code</li>
616
- <li><strong>Validate environment variables</strong> are loaded correctly</li>
617
- </ol>
618
- <h2>Ready to Proceed?</h2>
619
- <p>Once you&#39;ve completed Phase 1 (Local Testing), let me know the results and we can move to Phase 2 (Deployment Testing). I&#39;m here to help troubleshoot any issues that come up during testing!</p>
620
-
621
- </div>
622
- </main>
623
- </div>
624
-
625
- <!-- Scripts -->
626
- <script>
627
- // Pass configuration to frontend
628
- window.docBuilderConfig = {
629
- features: {
630
- showPdfDownload: true,
631
- menuDefaultOpen: false
632
- }
633
- };
634
- </script>
635
- <script src="/js/main.js"></script>
636
-
637
- </body>
638
- </html>