@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
package/html/guides/document-standards.html DELETED
@@ -1,518 +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="Documentation site built with @knowcode/doc-builder">
7
- <title>Document Standards for @knowcode/doc-builder - Documentation</title>
8
-
9
- <!-- Fonts -->
10
- <link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet">
11
-
12
- <!-- Icons -->
13
- <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css">
14
-
15
- <!-- Mermaid -->
16
- <script src="https://cdn.jsdelivr.net/npm/mermaid@10.6.1/dist/mermaid.min.js"></script>
17
-
18
- <!-- Styles -->
19
- <link rel="stylesheet" href="/css/notion-style.css">
20
-
21
- <!-- Favicon -->
22
- <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>">
23
- </head>
24
- <body>
25
- <!-- Header -->
26
- <header class="header">
27
- <div class="header-content">
28
- <a href="/index.html" class="logo">Documentation</a>
29
-
30
- <div class="header-actions">
31
- <div class="deployment-info">
32
- <span class="deployment-date" title="Built with doc-builder v1.4.21">Last updated: Jul 21, 2025, 06:45 PM UTC</span>
33
- </div>
34
-
35
-
36
-
37
- <button id="theme-toggle" class="theme-toggle" aria-label="Toggle theme">
38
- <i class="fas fa-moon"></i>
39
- </button>
40
-
41
- <button id="menu-toggle" class="menu-toggle" aria-label="Toggle menu">
42
- <i class="fas fa-bars"></i>
43
- </button>
44
- </div>
45
- </div>
46
- </header>
47
-
48
- <!-- Preview Banner -->
49
- <div id="preview-banner" class="preview-banner">
50
- <div class="banner-content">
51
- <i class="fas fa-exclamation-triangle banner-icon"></i>
52
- <span class="banner-text">This documentation is a preview version - some content may be incomplete</span>
53
- <button id="dismiss-banner" class="banner-dismiss" aria-label="Dismiss banner">
54
- <i class="fas fa-times"></i>
55
- </button>
56
- </div>
57
- </div>
58
-
59
- <!-- Breadcrumbs -->
60
- <nav class="breadcrumbs" id="breadcrumbs">
61
- <!-- Breadcrumbs will be generated by JavaScript -->
62
- </nav>
63
-
64
- <!-- Main Content -->
65
- <div class="main-wrapper">
66
- <!-- Sidebar -->
67
- <aside class="sidebar">
68
- <div class="sidebar-header">
69
- <div class="filter-box">
70
- <input type="text" placeholder="Filter items..." class="filter-input" id="nav-filter">
71
- <i class="fas fa-search filter-icon"></i>
72
- </div>
73
- </div>
74
- <nav class="navigation">
75
-
76
- <div class="nav-section" data-level="0">
77
- <a class="nav-title" href="/README.html" >
78
- <i class="fas fa-home"></i> Documentation
79
- </a>
80
- <div class="nav-content" >
81
- <a href="/README.html" class="nav-item" data-tooltip="@knowcode/doc-builder."><i class="fas fa-file-alt"></i> Overview</a>
82
- <a href="/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>
83
- <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></div></div>
84
- <div class="nav-section" data-level="1">
85
- <a class="nav-title collapsible expanded" href="#" data-target="nav-guides-1" >
86
- <i class="fas fa-chevron-right collapse-icon"></i><i class="fas fa-folder"></i> Guides
87
- </a>
88
- <div class="nav-content" id="nav-guides-1">
89
- <a href="/guides/authentication-guide.html" class="nav-item" data-tooltip="This guide explains how to configure and use the built-in authentication feature in @knowcode/doc-builder to protect your documentation with basic..."><i class="fas fa-file-alt"></i> Authentication Guide</a>
90
- <a href="/guides/DOCUMENT-STANDARDS.html" class="nav-item active" data-tooltip="This document defines the documentation standards and conventions for the @knowcode/doc-builder project."><i class="fas fa-file-alt"></i> DOCUMENT STANDARDS</a></div></div>
91
- </nav>
92
- <div class="resize-handle"></div>
93
- </aside>
94
-
95
- <!-- Content Area -->
96
- <main class="content">
97
- <div class="content-inner">
98
- <h1>Document Standards for @knowcode/doc-builder</h1>
99
- <p><strong>Generated</strong>: 2025-07-21 18:00 UTC<br><strong>Status</strong>: Complete<br><strong>Verified</strong>: ✅</p>
100
- <h2>Overview</h2>
101
- <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>
102
- <h2>Document Structure Standards</h2>
103
- <h3>Document Header Format</h3>
104
- <p>Every document MUST include the following metadata at the top:</p>
105
- <pre><code class="language-markdown"># Document Title
106
-
107
- **Generated**: YYYY-MM-DD HH:MM UTC
108
- **Status**: Draft/In Progress/Complete
109
- **Verified**: ✅ (for verified information) / ❓ (for speculated information)
110
-
111
- ## Overview
112
-
113
- Brief description of the document&#39;s contents and purpose.
114
- </code></pre>
115
- <h3>Section Organization</h3>
116
- <ol>
117
- <li><strong>Title</strong> (H1) - Single, descriptive title</li>
118
- <li><strong>Metadata</strong> - Generation date, status, verification</li>
119
- <li><strong>Overview</strong> - Brief summary of document purpose</li>
120
- <li><strong>Main Content</strong> - Organized with clear headings</li>
121
- <li><strong>Document History</strong> - Track significant changes</li>
122
- </ol>
123
- <h2>Naming Conventions</h2>
124
- <h3>Document File Names</h3>
125
- <p>Use lowercase with hyphens, following these patterns:</p>
126
- <ul>
127
- <li><strong>Feature Documentation</strong>: <code>feature-{name}-guide.md</code></li>
128
- <li><strong>API Documentation</strong>: <code>api-{endpoint}-reference.md</code></li>
129
- <li><strong>Technical Guides</strong>: <code>{component}-{topic}-guide.md</code></li>
130
- <li><strong>Architecture Documents</strong>: <code>architecture-{system}-overview.md</code></li>
131
- <li><strong>Implementation Plans</strong>: <code>plan-{feature}-implementation.md</code></li>
132
- <li><strong>Analysis Documents</strong>: <code>analysis-{topic}-{specifics}.md</code></li>
133
- <li><strong>Troubleshooting Guides</strong>: <code>troubleshoot-{issue}-guide.md</code></li>
134
- <li><strong>Change Logs</strong>: <code>CHANGELOG.md</code> (always uppercase)</li>
135
- </ul>
136
- <h3>Special Files</h3>
137
- <ul>
138
- <li><code>README.md</code> - Project overview and getting started</li>
139
- <li><code>CHANGELOG.md</code> - Version history following Keep a Changelog format</li>
140
- <li><code>CLAUDE.md</code> - AI assistant guidance (project-specific)</li>
141
- <li><code>DOCUMENT-STANDARDS.md</code> - This file</li>
142
- </ul>
143
- <h2>Content Standards</h2>
144
- <h3>1. Mermaid Diagrams</h3>
145
- <p>Include diagrams wherever they help explain complex concepts:</p>
146
- <pre><code class="language-markdown"><div class="mermaid-wrapper">
147
- <div class="mermaid-title">Diagram</div>
148
- <div class="mermaid">graph TD
149
- A[User Input] --> B{Valid?}
150
- B -->|Yes| C[Process]
151
- B -->|No| D[Error]
152
- C --> E[Output]
153
-
154
- style A fill:#f9f,stroke:#333,stroke-width:2px
155
- style E fill:#9f9,stroke:#333,stroke-width:2px</div>
156
- </div>
157
- </code></pre>
158
- <p>Guidelines:</p>
159
- <ul>
160
- <li>Use consistent node naming</li>
161
- <li>Add clear labels and descriptions</li>
162
- <li>Apply styling for better visual hierarchy</li>
163
- <li>Include diagram titles where appropriate</li>
164
- </ul>
165
- <h3>2. Information Verification</h3>
166
- <p>Mark all information with verification status:</p>
167
- <ul>
168
- <li>✅ <strong>Verified</strong>: Information confirmed through testing or official sources</li>
169
- <li>❓ <strong>Speculated</strong>: Assumptions or unconfirmed information</li>
170
- <li>⚠️ <strong>Warning</strong>: Important caveats or potential issues</li>
171
- <li>🚧 <strong>In Progress</strong>: Features or documentation under development</li>
172
- </ul>
173
- <p>Example:</p>
174
- <pre><code class="language-markdown">### Feature Status
175
- - ✅ **Markdown parsing**: Fully implemented and tested
176
- - ❓ **Performance impact**: Estimated 100ms for 50 files
177
- - ⚠️ **Large files**: May timeout on files &gt; 10MB
178
- - 🚧 **Search feature**: Currently in development
179
- </code></pre>
180
- <h3>3. Code Examples</h3>
181
- <p>Always include practical, tested examples:</p>
182
- <pre><code class="language-javascript">// Good example - with context and error handling
183
- const { build } = require(&#39;@knowcode/doc-builder&#39;);
184
-
185
- const config = {
186
- siteName: &#39;My Documentation&#39;,
187
- docsDir: &#39;./docs&#39;,
188
- outputDir: &#39;./dist&#39;
189
- };
190
-
191
- try {
192
- await build(config);
193
- console.log(&#39;✅ Build successful&#39;);
194
- } catch (error) {
195
- console.error(&#39;❌ Build failed:&#39;, error.message);
196
- }
197
- </code></pre>
198
- <p>Guidelines:</p>
199
- <ul>
200
- <li>Use syntax highlighting</li>
201
- <li>Include error handling</li>
202
- <li>Add helpful comments</li>
203
- <li>Show both correct and incorrect usage</li>
204
- <li>Test all examples before documenting</li>
205
- </ul>
206
- <h3>4. Command Examples</h3>
207
- <p>Format commands clearly with descriptions:</p>
208
- <pre><code class="language-bash"># Install the package
209
- npm install -D @knowcode/doc-builder
210
-
211
- # Build documentation
212
- npx doc-builder build
213
-
214
- # Start development server
215
- npx doc-builder dev --port 3000
216
-
217
- # Deploy to Vercel
218
- npx doc-builder deploy --prod
219
- </code></pre>
220
- <h2>Version Control Standards</h2>
221
- <h3>Changelog Management</h3>
222
- <p>ALWAYS maintain <code>CHANGELOG.md</code> for all significant or material changes:</p>
223
- <pre><code class="language-markdown">## [1.4.12] - 2025-07-21
224
-
225
- ### Fixed
226
- - Fixed h1 title alignment to extend full width
227
- - Added negative margins to counteract padding
228
-
229
- ### Background
230
- - The h1 was appearing offset due to content padding
231
- - Now extends full width for better hierarchy
232
- </code></pre>
233
- <p>Categories:</p>
234
- <ul>
235
- <li><strong>Added</strong> - New features</li>
236
- <li><strong>Changed</strong> - Changes to existing functionality</li>
237
- <li><strong>Deprecated</strong> - Soon-to-be removed features</li>
238
- <li><strong>Removed</strong> - Removed features</li>
239
- <li><strong>Fixed</strong> - Bug fixes</li>
240
- <li><strong>Security</strong> - Security fixes</li>
241
- <li><strong>Background</strong> - Context for the changes</li>
242
- </ul>
243
- <h3>Commit Messages</h3>
244
- <p>Follow conventional commits:</p>
245
- <ul>
246
- <li><code>feat:</code> New features</li>
247
- <li><code>fix:</code> Bug fixes</li>
248
- <li><code>docs:</code> Documentation changes</li>
249
- <li><code>chore:</code> Maintenance tasks</li>
250
- <li><code>refactor:</code> Code refactoring</li>
251
- <li><code>test:</code> Test additions/changes</li>
252
- </ul>
253
- <h2>Markdown Best Practices</h2>
254
- <h3>Headers</h3>
255
- <pre><code class="language-markdown"># Main Title (H1 - one per document)
256
-
257
- ## Major Section (H2)
258
-
259
- ### Subsection (H3)
260
-
261
- #### Detail Level (H4)
262
- </code></pre>
263
- <ul>
264
- <li>Use hierarchical structure</li>
265
- <li>Don&#39;t skip levels</li>
266
- <li>Keep headers concise but descriptive</li>
267
- </ul>
268
- <h3>Lists</h3>
269
- <p>Unordered lists for non-sequential items:</p>
270
- <pre><code class="language-markdown">- First item
271
- - Second item
272
- - Nested item
273
- - Another nested item
274
- - Third item
275
- </code></pre>
276
- <p>Numbered lists for sequential steps:</p>
277
- <pre><code class="language-markdown">1. First step
278
- 2. Second step
279
- 3. Third step
280
- </code></pre>
281
- <h3>Tables</h3>
282
- <p>Keep tables readable and well-formatted:</p>
283
- <pre><code class="language-markdown">| Feature | Status | Version | Notes |
284
- |---------|--------|---------|-------|
285
- | Mermaid | ✅ Ready | 1.0.0 | Full support |
286
- | Search | 🚧 WIP | 1.5.0 | In development |
287
- | Auth | ✅ Ready | 1.3.0 | Optional feature |
288
- </code></pre>
289
- <h3>Links</h3>
290
- <ul>
291
- <li>Use descriptive link text: <code>[View deployment guide](./deploy.md)</code></li>
292
- <li>Avoid: <code>[click here](./deploy.md)</code></li>
293
- <li>Prefer relative links for internal docs</li>
294
- <li>Use absolute URLs for external resources</li>
295
- </ul>
296
- <h2>Quality Standards</h2>
297
- <h3>Clarity</h3>
298
- <ul>
299
- <li>Write for your target audience</li>
300
- <li>Define technical terms on first use</li>
301
- <li>Use simple language where possible</li>
302
- <li>Include examples for complex concepts</li>
303
- </ul>
304
- <h3>Completeness</h3>
305
- <ul>
306
- <li>Cover all aspects of the topic</li>
307
- <li>Include edge cases and limitations</li>
308
- <li>Document prerequisites</li>
309
- <li>Provide troubleshooting guidance</li>
310
- </ul>
311
- <h3>Accuracy</h3>
312
- <ul>
313
- <li>Verify all technical details</li>
314
- <li>Test code examples</li>
315
- <li>Update when implementation changes</li>
316
- <li>Mark speculation clearly</li>
317
- </ul>
318
- <h3>Consistency</h3>
319
- <ul>
320
- <li>Use same terminology throughout</li>
321
- <li>Follow naming conventions</li>
322
- <li>Maintain style consistency</li>
323
- <li>Cross-reference related documents</li>
324
- </ul>
325
- <h2>Document Types</h2>
326
- <h3>1. Feature Documentation</h3>
327
- <p>Structure:</p>
328
- <pre><code class="language-markdown"># Feature Name
329
-
330
- **Generated**: [date]
331
- **Status**: Complete
332
- **Verified**: ✅
333
-
334
- ## Overview
335
- What the feature does and why it exists
336
-
337
- ## Usage
338
- How to use the feature with examples
339
-
340
- ## Configuration
341
- Available options and settings
342
-
343
- ## Examples
344
- Practical use cases
345
-
346
- ## Troubleshooting
347
- Common issues and solutions
348
- </code></pre>
349
- <h3>2. Technical Guides</h3>
350
- <p>Structure:</p>
351
- <pre><code class="language-markdown"># Technical Guide: [Topic]
352
-
353
- **Generated**: [date]
354
- **Status**: Complete
355
- **Verified**: ✅
356
-
357
- ## Overview
358
- Technical context and goals
359
-
360
- ## Architecture
361
- System design and components
362
-
363
- ## Implementation
364
- Step-by-step technical details
365
-
366
- ## Testing
367
- How to verify functionality
368
-
369
- ## Performance
370
- Benchmarks and optimization
371
- </code></pre>
372
- <h3>3. API Documentation</h3>
373
- <p>Structure:</p>
374
- <pre><code class="language-markdown"># API: [Endpoint/Function Name]
375
-
376
- **Generated**: [date]
377
- **Status**: Complete
378
- **Verified**: ✅
379
-
380
- ## Overview
381
- What the API does
382
-
383
- ## Parameters
384
- | Name | Type | Required | Description |
385
- |------|------|----------|-------------|
386
-
387
- ## Response
388
- Expected response format
389
-
390
- ## Examples
391
- Request/response examples
392
-
393
- ## Error Handling
394
- Possible errors and meanings
395
- </code></pre>
396
- <h2>File Organization</h2>
397
- <h3>Directory Structure</h3>
398
- <pre><code>doc-builder/
399
- ├── README.md # Project overview
400
- ├── CHANGELOG.md # Version history
401
- ├── CLAUDE.md # AI assistant guide
402
- ├── DOCUMENT-STANDARDS.md # This file
403
- ├── docs/ # Additional documentation
404
- │ ├── guides/ # How-to guides
405
- │ ├── api/ # API documentation
406
- │ ├── architecture/ # System design docs
407
- │ └── troubleshooting/ # Problem-solving guides
408
- </code></pre>
409
- <h3>File Management</h3>
410
- <ul>
411
- <li>Keep active documentation in appropriate directories</li>
412
- <li>Archive outdated docs with date suffix: <code>old-guide-2025-01-15.md</code></li>
413
- <li>Remove unused files after archiving</li>
414
- <li>Maintain README.md in each directory explaining contents</li>
415
- </ul>
416
- <h2>Special Considerations</h2>
417
- <h3>Security</h3>
418
- <ul>
419
- <li>Never include credentials or API keys</li>
420
- <li>Use placeholders for sensitive data: <code>API_KEY=&lt;your-api-key-here&gt;</code></li>
421
- <li>Document security implications</li>
422
- <li>Include security warnings where relevant</li>
423
- </ul>
424
- <h3>Performance</h3>
425
- <ul>
426
- <li>Document performance characteristics</li>
427
- <li>Include benchmarks where applicable</li>
428
- <li>Note resource requirements</li>
429
- <li>Provide optimization tips</li>
430
- </ul>
431
- <h3>Accessibility</h3>
432
- <ul>
433
- <li>Use clear, simple language</li>
434
- <li>Provide alt text for images</li>
435
- <li>Structure documents logically</li>
436
- <li>Consider screen reader users</li>
437
- </ul>
438
- <h2>Document Maintenance</h2>
439
- <h3>Review Schedule</h3>
440
- <ul>
441
- <li>Technical docs: Review with each minor version</li>
442
- <li>API docs: Review with any API change</li>
443
- <li>Guides: Review quarterly</li>
444
- <li>README: Update with significant changes</li>
445
- </ul>
446
- <h3>Update Process</h3>
447
- <ol>
448
- <li>Check document metadata</li>
449
- <li>Verify technical accuracy</li>
450
- <li>Update examples</li>
451
- <li>Test code snippets</li>
452
- <li>Update changelog</li>
453
- <li>Commit with descriptive message</li>
454
- </ol>
455
- <h3>Document History</h3>
456
- <p>Include at the bottom of long-lived documents:</p>
457
- <pre><code class="language-markdown">## Document History
458
-
459
- | Date | Version | Author | Changes |
460
- |------|---------|--------|---------|
461
- | 2025-07-21 | 1.0 | System | Initial creation |
462
- | 2025-07-22 | 1.1 | Dev | Added examples |
463
- </code></pre>
464
- <h2>Tools and Automation</h2>
465
- <h3>Building Documentation</h3>
466
- <p>The doc-builder automatically:</p>
467
- <ul>
468
- <li>Generates navigation from folder structure</li>
469
- <li>Extracts summaries for tooltips</li>
470
- <li>Renders mermaid diagrams</li>
471
- <li>Applies syntax highlighting</li>
472
- <li>Creates responsive layouts</li>
473
- </ul>
474
- <h3>Preview Changes</h3>
475
- <pre><code class="language-bash"># Preview documentation locally
476
- npx doc-builder dev
477
-
478
- # Build and check output
479
- npx doc-builder build
480
- open html/index.html
481
- </code></pre>
482
- <h2>Conclusion</h2>
483
- <p>Following these standards ensures:</p>
484
- <ul>
485
- <li>Consistent, professional documentation</li>
486
- <li>Easy navigation and discovery</li>
487
- <li>Clear communication of technical concepts</li>
488
- <li>Maintainable documentation over time</li>
489
- </ul>
490
- <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>
491
- <hr>
492
- <h2>Document History</h2>
493
- <table>
494
- <thead>
495
- <tr>
496
- <th>Date</th>
497
- <th>Version</th>
498
- <th>Author</th>
499
- <th>Changes</th>
500
- </tr>
501
- </thead>
502
- <tbody><tr>
503
- <td>2025-07-21</td>
504
- <td>1.0</td>
505
- <td>System</td>
506
- <td>Initial creation from project standards</td>
507
- </tr>
508
- </tbody></table>
509
-
510
- </div>
511
- </main>
512
- </div>
513
-
514
- <!-- Scripts -->
515
- <script src="/js/main.js"></script>
516
-
517
- </body>
518
- </html>