@knowcode/doc-builder 1.6.4 → 1.7.0
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.
- package/assets/css/notion-style.css +23 -13
- package/assets/js/main.js +19 -1
- package/cli.js +2 -0
- package/html/README.html +13 -4
- package/html/css/notion-style.css +23 -13
- package/html/documentation-index.html +13 -4
- package/html/guides/authentication-guide.html +12 -3
- package/html/guides/claude-workflow-guide.html +58 -49
- package/html/guides/documentation-standards.html +23 -14
- package/html/guides/phosphor-icons-guide.html +24 -15
- package/html/guides/search-engine-verification-guide.html +12 -3
- package/html/guides/seo-guide.html +16 -7
- package/html/guides/seo-optimization-guide.html +16 -7
- package/html/guides/troubleshooting-guide.html +12 -3
- package/html/guides/windows-setup-guide.html +12 -3
- package/html/index.html +13 -4
- package/html/js/main.js +19 -1
- package/html/launch/README.html +12 -3
- package/html/launch/bubble-plugin-specification.html +12 -3
- package/html/launch/go-to-market-strategy.html +12 -3
- package/html/launch/launch-announcements.html +12 -3
- package/html/sitemap.xml +21 -21
- package/html/vercel-cli-setup-guide.html +12 -3
- package/html/vercel-first-time-setup-guide.html +20 -11
- package/lib/config.js +13 -2
- package/lib/core-builder.js +9 -0
- package/lib/emoji-mapper.js +22 -1
- package/package.json +1 -1
- package/scripts/Screenshot 2025-07-23 at 15.39.41.png +0 -0
|
@@ -319,7 +319,7 @@ pre code {
|
|
|
319
319
|
background: var(--color-bg-secondary);
|
|
320
320
|
border-right: 1px solid var(--color-border-default);
|
|
321
321
|
overflow: hidden;
|
|
322
|
-
transition: width var(--duration-normal);
|
|
322
|
+
transition: width var(--duration-normal), transform 0.3s ease, margin-left 0.3s ease;
|
|
323
323
|
min-width: 200px;
|
|
324
324
|
max-width: 500px;
|
|
325
325
|
user-select: none;
|
|
@@ -330,6 +330,14 @@ pre code {
|
|
|
330
330
|
height: 100%;
|
|
331
331
|
}
|
|
332
332
|
|
|
333
|
+
/* Desktop sidebar closed state */
|
|
334
|
+
@media (min-width: 769px) {
|
|
335
|
+
.sidebar.closed {
|
|
336
|
+
transform: translateX(-100%);
|
|
337
|
+
margin-left: calc(var(--sidebar-width) * -1);
|
|
338
|
+
}
|
|
339
|
+
}
|
|
340
|
+
|
|
333
341
|
/* Banner adjustment no longer needed with relative positioning */
|
|
334
342
|
|
|
335
343
|
|
|
@@ -1958,31 +1966,33 @@ tr:hover {
|
|
|
1958
1966
|
/* Phosphor Icons Alignment */
|
|
1959
1967
|
.ph {
|
|
1960
1968
|
display: inline-block;
|
|
1961
|
-
vertical-align:
|
|
1962
|
-
line-height:
|
|
1969
|
+
vertical-align: middle;
|
|
1970
|
+
line-height: 1;
|
|
1963
1971
|
position: relative;
|
|
1964
|
-
top: 0.
|
|
1972
|
+
top: -0.05em; /* Slight upward adjustment for better baseline alignment */
|
|
1965
1973
|
}
|
|
1966
1974
|
|
|
1967
1975
|
/* Ensure icons in headings are properly aligned */
|
|
1968
1976
|
h1 .ph, h2 .ph, h3 .ph, h4 .ph, h5 .ph, h6 .ph {
|
|
1969
1977
|
font-size: 0.85em; /* Slightly smaller in headings */
|
|
1970
|
-
line-height:
|
|
1971
|
-
top: 0.
|
|
1978
|
+
line-height: 1;
|
|
1979
|
+
top: -0.05em;
|
|
1972
1980
|
}
|
|
1973
1981
|
|
|
1974
1982
|
/* Icons in lists need special handling */
|
|
1975
1983
|
li .ph {
|
|
1976
1984
|
margin-right: 0.3em;
|
|
1977
|
-
font-size: 1.
|
|
1978
|
-
line-height:
|
|
1979
|
-
|
|
1985
|
+
font-size: 1.1em;
|
|
1986
|
+
line-height: 1;
|
|
1987
|
+
vertical-align: middle;
|
|
1988
|
+
top: -0.05em;
|
|
1980
1989
|
}
|
|
1981
1990
|
|
|
1982
1991
|
/* Icons in tables */
|
|
1983
1992
|
td .ph, th .ph {
|
|
1984
|
-
line-height:
|
|
1985
|
-
|
|
1993
|
+
line-height: 1;
|
|
1994
|
+
vertical-align: middle;
|
|
1995
|
+
top: -0.05em;
|
|
1986
1996
|
}
|
|
1987
1997
|
|
|
1988
1998
|
/* Icons in navigation */
|
|
@@ -1995,7 +2005,7 @@ td .ph, th .ph {
|
|
|
1995
2005
|
|
|
1996
2006
|
/* Icon size adjustments for better visual balance */
|
|
1997
2007
|
.content p .ph {
|
|
1998
|
-
font-size: 1.
|
|
2008
|
+
font-size: 1.1em; /* Slightly larger than text for visual balance */
|
|
1999
2009
|
}
|
|
2000
2010
|
|
|
2001
2011
|
/* Special handling for inline code with icons */
|
|
@@ -2008,5 +2018,5 @@ code .ph {
|
|
|
2008
2018
|
|
|
2009
2019
|
/* Additional fine-tuning for specific contexts */
|
|
2010
2020
|
.content-inner .ph {
|
|
2011
|
-
transform
|
|
2021
|
+
/* Remove the transform as we're now using consistent vertical-align: middle */
|
|
2012
2022
|
}
|
package/assets/js/main.js
CHANGED
|
@@ -494,6 +494,14 @@ function updateThemeIcon(theme) {
|
|
|
494
494
|
const menuToggle = document.getElementById('menu-toggle');
|
|
495
495
|
const sidebar = document.querySelector('.sidebar');
|
|
496
496
|
|
|
497
|
+
// Set initial menu state based on configuration
|
|
498
|
+
if (sidebar && window.innerWidth > 768) {
|
|
499
|
+
const menuDefaultOpen = window.docBuilderConfig?.features?.menuDefaultOpen !== false;
|
|
500
|
+
if (!menuDefaultOpen) {
|
|
501
|
+
sidebar.classList.add('closed');
|
|
502
|
+
}
|
|
503
|
+
}
|
|
504
|
+
|
|
497
505
|
// Create overlay element for mobile
|
|
498
506
|
let overlay = document.querySelector('.sidebar-overlay');
|
|
499
507
|
if (!overlay && window.innerWidth <= 768) {
|
|
@@ -504,7 +512,13 @@ if (!overlay && window.innerWidth <= 768) {
|
|
|
504
512
|
|
|
505
513
|
if (menuToggle) {
|
|
506
514
|
menuToggle.addEventListener('click', () => {
|
|
507
|
-
|
|
515
|
+
if (window.innerWidth <= 768) {
|
|
516
|
+
// Mobile: toggle 'open' class
|
|
517
|
+
sidebar.classList.toggle('open');
|
|
518
|
+
} else {
|
|
519
|
+
// Desktop: toggle 'closed' class
|
|
520
|
+
sidebar.classList.toggle('closed');
|
|
521
|
+
}
|
|
508
522
|
if (overlay) {
|
|
509
523
|
overlay.classList.toggle('active');
|
|
510
524
|
}
|
|
@@ -1278,6 +1292,10 @@ function exportToPDF() {
|
|
|
1278
1292
|
|
|
1279
1293
|
// Add PDF export button functionality
|
|
1280
1294
|
function addPDFExportButton() {
|
|
1295
|
+
// Check configuration - default to true if not set
|
|
1296
|
+
const showPdfDownload = window.docBuilderConfig?.features?.showPdfDownload !== false;
|
|
1297
|
+
if (!showPdfDownload) return;
|
|
1298
|
+
|
|
1281
1299
|
const headerActions = document.querySelector('.header-actions');
|
|
1282
1300
|
if (headerActions) {
|
|
1283
1301
|
const pdfButton = document.createElement('button');
|
package/cli.js
CHANGED
|
@@ -72,6 +72,8 @@ program
|
|
|
72
72
|
.option('--legacy', 'use legacy mode for backward compatibility')
|
|
73
73
|
.option('--no-auth', 'disable authentication even if configured')
|
|
74
74
|
.option('--no-changelog', 'disable automatic changelog generation')
|
|
75
|
+
.option('--no-pdf', 'hide PDF download icon in header')
|
|
76
|
+
.option('--menu-closed', 'start with navigation menu closed')
|
|
75
77
|
.addHelpText('after', `
|
|
76
78
|
${chalk.yellow('Examples:')}
|
|
77
79
|
${chalk.gray('$')} doc-builder build ${chalk.gray('# Build with defaults')}
|
package/html/README.html
CHANGED
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-24T08:19:52.195Z",
|
|
67
|
+
"dateModified": "2025-07-24T08:19:52.195Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/README.html"
|
|
@@ -97,7 +97,7 @@
|
|
|
97
97
|
|
|
98
98
|
<div class="header-actions">
|
|
99
99
|
<div class="deployment-info">
|
|
100
|
-
<span class="deployment-date" title="Built with doc-builder v1.6.
|
|
100
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
|
|
101
101
|
</div>
|
|
102
102
|
|
|
103
103
|
|
|
@@ -294,7 +294,7 @@ module.exports = {
|
|
|
294
294
|
siteDescription: 'Transform markdown into beautiful documentation',
|
|
295
295
|
docsDir: 'docs',
|
|
296
296
|
outputDir: 'html',
|
|
297
|
-
favicon: '
|
|
297
|
+
favicon: '✨' // Can be emoji or path to image
|
|
298
298
|
};
|
|
299
299
|
</code></pre>
|
|
300
300
|
<p><em>The CLI creates and updates this for you</em></p>
|
|
@@ -422,6 +422,15 @@ docBuilder.build({
|
|
|
422
422
|
</div>
|
|
423
423
|
|
|
424
424
|
<!-- Scripts -->
|
|
425
|
+
<script>
|
|
426
|
+
// Pass configuration to frontend
|
|
427
|
+
window.docBuilderConfig = {
|
|
428
|
+
features: {
|
|
429
|
+
showPdfDownload: true,
|
|
430
|
+
menuDefaultOpen: true
|
|
431
|
+
}
|
|
432
|
+
};
|
|
433
|
+
</script>
|
|
425
434
|
<script src="/js/main.js"></script>
|
|
426
435
|
|
|
427
436
|
</body>
|
|
@@ -319,7 +319,7 @@ pre code {
|
|
|
319
319
|
background: var(--color-bg-secondary);
|
|
320
320
|
border-right: 1px solid var(--color-border-default);
|
|
321
321
|
overflow: hidden;
|
|
322
|
-
transition: width var(--duration-normal);
|
|
322
|
+
transition: width var(--duration-normal), transform 0.3s ease, margin-left 0.3s ease;
|
|
323
323
|
min-width: 200px;
|
|
324
324
|
max-width: 500px;
|
|
325
325
|
user-select: none;
|
|
@@ -330,6 +330,14 @@ pre code {
|
|
|
330
330
|
height: 100%;
|
|
331
331
|
}
|
|
332
332
|
|
|
333
|
+
/* Desktop sidebar closed state */
|
|
334
|
+
@media (min-width: 769px) {
|
|
335
|
+
.sidebar.closed {
|
|
336
|
+
transform: translateX(-100%);
|
|
337
|
+
margin-left: calc(var(--sidebar-width) * -1);
|
|
338
|
+
}
|
|
339
|
+
}
|
|
340
|
+
|
|
333
341
|
/* Banner adjustment no longer needed with relative positioning */
|
|
334
342
|
|
|
335
343
|
|
|
@@ -1958,31 +1966,33 @@ tr:hover {
|
|
|
1958
1966
|
/* Phosphor Icons Alignment */
|
|
1959
1967
|
.ph {
|
|
1960
1968
|
display: inline-block;
|
|
1961
|
-
vertical-align:
|
|
1962
|
-
line-height:
|
|
1969
|
+
vertical-align: middle;
|
|
1970
|
+
line-height: 1;
|
|
1963
1971
|
position: relative;
|
|
1964
|
-
top: 0.
|
|
1972
|
+
top: -0.05em; /* Slight upward adjustment for better baseline alignment */
|
|
1965
1973
|
}
|
|
1966
1974
|
|
|
1967
1975
|
/* Ensure icons in headings are properly aligned */
|
|
1968
1976
|
h1 .ph, h2 .ph, h3 .ph, h4 .ph, h5 .ph, h6 .ph {
|
|
1969
1977
|
font-size: 0.85em; /* Slightly smaller in headings */
|
|
1970
|
-
line-height:
|
|
1971
|
-
top: 0.
|
|
1978
|
+
line-height: 1;
|
|
1979
|
+
top: -0.05em;
|
|
1972
1980
|
}
|
|
1973
1981
|
|
|
1974
1982
|
/* Icons in lists need special handling */
|
|
1975
1983
|
li .ph {
|
|
1976
1984
|
margin-right: 0.3em;
|
|
1977
|
-
font-size: 1.
|
|
1978
|
-
line-height:
|
|
1979
|
-
|
|
1985
|
+
font-size: 1.1em;
|
|
1986
|
+
line-height: 1;
|
|
1987
|
+
vertical-align: middle;
|
|
1988
|
+
top: -0.05em;
|
|
1980
1989
|
}
|
|
1981
1990
|
|
|
1982
1991
|
/* Icons in tables */
|
|
1983
1992
|
td .ph, th .ph {
|
|
1984
|
-
line-height:
|
|
1985
|
-
|
|
1993
|
+
line-height: 1;
|
|
1994
|
+
vertical-align: middle;
|
|
1995
|
+
top: -0.05em;
|
|
1986
1996
|
}
|
|
1987
1997
|
|
|
1988
1998
|
/* Icons in navigation */
|
|
@@ -1995,7 +2005,7 @@ td .ph, th .ph {
|
|
|
1995
2005
|
|
|
1996
2006
|
/* Icon size adjustments for better visual balance */
|
|
1997
2007
|
.content p .ph {
|
|
1998
|
-
font-size: 1.
|
|
2008
|
+
font-size: 1.1em; /* Slightly larger than text for visual balance */
|
|
1999
2009
|
}
|
|
2000
2010
|
|
|
2001
2011
|
/* Special handling for inline code with icons */
|
|
@@ -2008,5 +2018,5 @@ code .ph {
|
|
|
2008
2018
|
|
|
2009
2019
|
/* Additional fine-tuning for specific contexts */
|
|
2010
2020
|
.content-inner .ph {
|
|
2011
|
-
transform
|
|
2021
|
+
/* Remove the transform as we're now using consistent vertical-align: middle */
|
|
2012
2022
|
}
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-24T08:19:52.206Z",
|
|
67
|
+
"dateModified": "2025-07-24T08:19:52.206Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/documentation-index.html"
|
|
@@ -97,7 +97,7 @@
|
|
|
97
97
|
|
|
98
98
|
<div class="header-actions">
|
|
99
99
|
<div class="deployment-info">
|
|
100
|
-
<span class="deployment-date" title="Built with doc-builder v1.6.
|
|
100
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
|
|
101
101
|
</div>
|
|
102
102
|
|
|
103
103
|
|
|
@@ -302,7 +302,7 @@
|
|
|
302
302
|
|
|
303
303
|
**Generated**: YYYY-MM-DD HH:MM UTC
|
|
304
304
|
**Status**: Draft/Complete
|
|
305
|
-
**Verified**:
|
|
305
|
+
**Verified**: ✅/❓
|
|
306
306
|
|
|
307
307
|
## Overview
|
|
308
308
|
|
|
@@ -362,6 +362,15 @@ Detailed information...
|
|
|
362
362
|
</div>
|
|
363
363
|
|
|
364
364
|
<!-- Scripts -->
|
|
365
|
+
<script>
|
|
366
|
+
// Pass configuration to frontend
|
|
367
|
+
window.docBuilderConfig = {
|
|
368
|
+
features: {
|
|
369
|
+
showPdfDownload: true,
|
|
370
|
+
menuDefaultOpen: true
|
|
371
|
+
}
|
|
372
|
+
};
|
|
373
|
+
</script>
|
|
365
374
|
<script src="/js/main.js"></script>
|
|
366
375
|
|
|
367
376
|
</body>
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-24T08:19:52.210Z",
|
|
67
|
+
"dateModified": "2025-07-24T08:19:52.210Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/guides/authentication-guide.html"
|
|
@@ -103,7 +103,7 @@
|
|
|
103
103
|
|
|
104
104
|
<div class="header-actions">
|
|
105
105
|
<div class="deployment-info">
|
|
106
|
-
<span class="deployment-date" title="Built with doc-builder v1.6.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
|
@@ -459,6 +459,15 @@ Please bookmark the site after logging in.
|
|
|
459
459
|
</div>
|
|
460
460
|
|
|
461
461
|
<!-- Scripts -->
|
|
462
|
+
<script>
|
|
463
|
+
// Pass configuration to frontend
|
|
464
|
+
window.docBuilderConfig = {
|
|
465
|
+
features: {
|
|
466
|
+
showPdfDownload: true,
|
|
467
|
+
menuDefaultOpen: true
|
|
468
|
+
}
|
|
469
|
+
};
|
|
470
|
+
</script>
|
|
462
471
|
<script src="/js/main.js"></script>
|
|
463
472
|
|
|
464
473
|
</body>
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-24T08:19:52.215Z",
|
|
67
|
+
"dateModified": "2025-07-24T08:19:52.215Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/guides/claude-workflow-guide.html"
|
|
@@ -103,7 +103,7 @@
|
|
|
103
103
|
|
|
104
104
|
<div class="header-actions">
|
|
105
105
|
<div class="deployment-info">
|
|
106
|
-
<span class="deployment-date" title="Built with doc-builder v1.6.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
|
@@ -230,7 +230,7 @@ This file provides comprehensive guidance for Claude Code when working in this p
|
|
|
230
230
|
- Include metadata:
|
|
231
231
|
- **Generated**: YYYY-MM-DD HH:MM UTC
|
|
232
232
|
- **Status**: Draft/In Progress/Complete
|
|
233
|
-
- **Verified**:
|
|
233
|
+
- **Verified**: ✅ (for verified information) / ❓ (for speculated information)
|
|
234
234
|
|
|
235
235
|
### Document Structure
|
|
236
236
|
- All documentation goes in the `/docs` directory
|
|
@@ -265,12 +265,12 @@ This file provides comprehensive guidance for Claude Code when working in this p
|
|
|
265
265
|
</div>
|
|
266
266
|
|
|
267
267
|
#### 2. Information Verification
|
|
268
|
-
- Mark all information as either verified (
|
|
268
|
+
- Mark all information as either verified (✅) or speculated (❓)
|
|
269
269
|
- Include sources for verified information
|
|
270
270
|
- Clearly indicate assumptions
|
|
271
271
|
- Example:
|
|
272
|
-
-
|
|
273
|
-
-
|
|
272
|
+
- ✅ This API endpoint requires authentication (verified in auth.js:45)
|
|
273
|
+
- ❓ Response time should be under 200ms (performance requirement assumed)
|
|
274
274
|
|
|
275
275
|
#### 3. Code Examples
|
|
276
276
|
- Use proper syntax highlighting with language identifiers
|
|
@@ -279,7 +279,7 @@ This file provides comprehensive guidance for Claude Code when working in this p
|
|
|
279
279
|
- Add error handling in examples
|
|
280
280
|
- Example:
|
|
281
281
|
```javascript
|
|
282
|
-
//
|
|
282
|
+
// ✅ Correct way to call the API
|
|
283
283
|
try {
|
|
284
284
|
const response = await api.getData({ userId: 123 });
|
|
285
285
|
console.log('Data:', response.data);
|
|
@@ -287,7 +287,7 @@ try {
|
|
|
287
287
|
console.error('API Error:', error.message);
|
|
288
288
|
}
|
|
289
289
|
|
|
290
|
-
//
|
|
290
|
+
// ❌ Incorrect - missing error handling
|
|
291
291
|
const response = await api.getData({ userId: 123 });
|
|
292
292
|
</code></pre>
|
|
293
293
|
<h4>4. Practical Examples</h4>
|
|
@@ -522,7 +522,7 @@ For Claude to generate accurate and consistent content, include key organization
|
|
|
522
522
|
### Branding Guidelines
|
|
523
523
|
- **Company Tagline**: "Beautiful documentation with the least effort possible"
|
|
524
524
|
- **Primary Color**: #0070f3 (Vercel blue)
|
|
525
|
-
- **Logo**:
|
|
525
|
+
- **Logo**: ✨ (sparkle emoji)
|
|
526
526
|
- **Font Family**: Inter, system-ui
|
|
527
527
|
</code></pre>
|
|
528
528
|
<p>When these facts are included in your CLAUDE.md, Claude will:</p>
|
|
@@ -550,8 +550,8 @@ For Claude to generate accurate and consistent content, include key organization
|
|
|
550
550
|
|
|
551
551
|
### Information Verification
|
|
552
552
|
- Mark all verified vs. speculated information as a general document standard
|
|
553
|
-
- Use
|
|
554
|
-
- Use
|
|
553
|
+
- Use ✅ for verified information with source references
|
|
554
|
+
- Use ❓ for assumptions or unverified information
|
|
555
555
|
|
|
556
556
|
### Development Practices
|
|
557
557
|
- Use Docker V2 for containerization
|
|
@@ -650,15 +650,15 @@ For Claude to generate accurate and consistent content, include key organization
|
|
|
650
650
|
</div>
|
|
651
651
|
<h4>Example: Without Environment Facts</h4>
|
|
652
652
|
<pre><code class="language-javascript">// Claude might generate:
|
|
653
|
-
const API_URL = 'https://api.example.com'; //
|
|
654
|
-
const author = 'Your Name'; //
|
|
655
|
-
const email = 'email@example.com'; //
|
|
653
|
+
const API_URL = 'https://api.example.com'; // ❓ Generic placeholder
|
|
654
|
+
const author = 'Your Name'; // ❓ Placeholder
|
|
655
|
+
const email = 'email@example.com'; // ❓ Generic example
|
|
656
656
|
</code></pre>
|
|
657
657
|
<h4>Example: With Environment Facts</h4>
|
|
658
658
|
<pre><code class="language-javascript">// Claude will generate:
|
|
659
|
-
const API_URL = 'https://api.knowcode.tech'; //
|
|
660
|
-
const author = 'Lindsay Smith'; //
|
|
661
|
-
const email = 'support@knowcode.tech'; //
|
|
659
|
+
const API_URL = 'https://api.knowcode.tech'; // ✅ Actual API URL
|
|
660
|
+
const author = 'Lindsay Smith'; // ✅ Correct author
|
|
661
|
+
const email = 'support@knowcode.tech'; // ✅ Real contact email
|
|
662
662
|
</code></pre>
|
|
663
663
|
<h2>Step 2: Initialize doc-builder</h2>
|
|
664
664
|
<pre><code class="language-bash"># Install doc-builder
|
|
@@ -906,43 +906,43 @@ npm run deploy:docs
|
|
|
906
906
|
## Best Practices Summary
|
|
907
907
|
|
|
908
908
|
### Documentation Creation
|
|
909
|
-
1.
|
|
910
|
-
2.
|
|
911
|
-
3.
|
|
912
|
-
4.
|
|
913
|
-
5.
|
|
914
|
-
6.
|
|
915
|
-
7.
|
|
916
|
-
8.
|
|
909
|
+
1. ✅ Use CLAUDE.md to maintain consistency across all documentation
|
|
910
|
+
2. ✅ Include visual diagrams (Mermaid) for complex concepts and workflows
|
|
911
|
+
3. ✅ Provide practical, working examples that can be copy-pasted
|
|
912
|
+
4. ✅ Mark verification status (✅/❓) for all technical information
|
|
913
|
+
5. ✅ Keep documentation close to code in the /docs directory
|
|
914
|
+
6. ✅ Include metadata headers with timestamps and status
|
|
915
|
+
7. ✅ Add troubleshooting sections for common issues
|
|
916
|
+
8. ✅ Cross-reference related documentation
|
|
917
917
|
|
|
918
918
|
### Claude Interaction
|
|
919
|
-
1.
|
|
920
|
-
2.
|
|
921
|
-
3.
|
|
922
|
-
4.
|
|
923
|
-
5.
|
|
924
|
-
6.
|
|
925
|
-
7.
|
|
926
|
-
8.
|
|
919
|
+
1. ✅ Provide clear, specific requests with expected output format
|
|
920
|
+
2. ✅ Reference existing patterns from CLAUDE.md
|
|
921
|
+
3. ✅ Request iterative improvements - review and refine
|
|
922
|
+
4. ✅ Verify technical accuracy of generated content
|
|
923
|
+
5. ✅ Ask for troubleshooting sections explicitly
|
|
924
|
+
6. ✅ Request examples with error handling
|
|
925
|
+
7. ✅ Specify diagram types needed (sequence, flow, state)
|
|
926
|
+
8. ✅ Ask Claude to check its own work against CLAUDE.md standards
|
|
927
927
|
|
|
928
928
|
### Documentation Maintenance
|
|
929
|
-
1.
|
|
930
|
-
2.
|
|
931
|
-
3.
|
|
932
|
-
4.
|
|
933
|
-
5.
|
|
934
|
-
6.
|
|
935
|
-
7.
|
|
929
|
+
1. ✅ Update docs when code changes
|
|
930
|
+
2. ✅ Archive outdated documentation
|
|
931
|
+
3. ✅ Maintain CHANGELOG.md
|
|
932
|
+
4. ✅ Review documentation quarterly
|
|
933
|
+
5. ✅ Test all code examples
|
|
934
|
+
6. ✅ Check for broken links
|
|
935
|
+
7. ✅ Update version references
|
|
936
936
|
|
|
937
937
|
### Deployment
|
|
938
|
-
1.
|
|
939
|
-
2.
|
|
940
|
-
3.
|
|
941
|
-
4.
|
|
942
|
-
5.
|
|
943
|
-
6.
|
|
944
|
-
7.
|
|
945
|
-
8.
|
|
938
|
+
1. ✅ Test locally before deploying (npm run dev:docs)
|
|
939
|
+
2. ✅ Build and verify output (npm run build:docs)
|
|
940
|
+
3. ✅ Use preview deployments first
|
|
941
|
+
4. ✅ Configure custom domains if needed
|
|
942
|
+
5. ✅ Enable HTTPS (automatic with Vercel)
|
|
943
|
+
6. ✅ Monitor deployment health
|
|
944
|
+
7. ✅ Disable Vercel authentication for public docs
|
|
945
|
+
8. ✅ Commit documentation changes before deploying
|
|
946
946
|
|
|
947
947
|
## Common Issues and Solutions
|
|
948
948
|
|
|
@@ -981,6 +981,15 @@ The key to success is iterative refinement of your CLAUDE.md file to capture you
|
|
|
981
981
|
</div>
|
|
982
982
|
|
|
983
983
|
<!-- Scripts -->
|
|
984
|
+
<script>
|
|
985
|
+
// Pass configuration to frontend
|
|
986
|
+
window.docBuilderConfig = {
|
|
987
|
+
features: {
|
|
988
|
+
showPdfDownload: true,
|
|
989
|
+
menuDefaultOpen: true
|
|
990
|
+
}
|
|
991
|
+
};
|
|
992
|
+
</script>
|
|
984
993
|
<script src="/js/main.js"></script>
|
|
985
994
|
|
|
986
995
|
</body>
|
|
@@ -63,8 +63,8 @@
|
|
|
63
63
|
"name": "Knowcode Ltd",
|
|
64
64
|
"url": "https://knowcode.tech"
|
|
65
65
|
},
|
|
66
|
-
"datePublished": "2025-07-
|
|
67
|
-
"dateModified": "2025-07-
|
|
66
|
+
"datePublished": "2025-07-24T08:19:52.220Z",
|
|
67
|
+
"dateModified": "2025-07-24T08:19:52.220Z",
|
|
68
68
|
"mainEntityOfPage": {
|
|
69
69
|
"@type": "WebPage",
|
|
70
70
|
"@id": "https://doc-builder-delta.vercel.app/guides/documentation-standards.html"
|
|
@@ -103,7 +103,7 @@
|
|
|
103
103
|
|
|
104
104
|
<div class="header-actions">
|
|
105
105
|
<div class="deployment-info">
|
|
106
|
-
<span class="deployment-date" title="Built with doc-builder v1.6.
|
|
106
|
+
<span class="deployment-date" title="Built with doc-builder v1.6.5">Last updated: Jul 24, 2025, 08:19 AM UTC</span>
|
|
107
107
|
</div>
|
|
108
108
|
|
|
109
109
|
|
|
@@ -196,7 +196,7 @@
|
|
|
196
196
|
|
|
197
197
|
**Generated**: YYYY-MM-DD HH:MM UTC
|
|
198
198
|
**Status**: Draft/In Progress/Complete
|
|
199
|
-
**Verified**:
|
|
199
|
+
**Verified**: ✅ (for verified information) / ❓ (for speculated information)
|
|
200
200
|
|
|
201
201
|
## Overview
|
|
202
202
|
|
|
@@ -261,9 +261,9 @@ Brief description of the document's contents and purpose.
|
|
|
261
261
|
</ul>
|
|
262
262
|
<p>Example:</p>
|
|
263
263
|
<pre><code class="language-markdown">### Feature Status
|
|
264
|
-
-
|
|
265
|
-
-
|
|
266
|
-
-
|
|
264
|
+
- ✅ **Markdown parsing**: Fully implemented and tested
|
|
265
|
+
- ❓ **Performance impact**: Estimated 100ms for 50 files
|
|
266
|
+
- ⚠️ **Large files**: May timeout on files > 10MB
|
|
267
267
|
- 🚧 **Search feature**: Currently in development
|
|
268
268
|
</code></pre>
|
|
269
269
|
<h3>3. Code Examples</h3>
|
|
@@ -279,9 +279,9 @@ const config = {
|
|
|
279
279
|
|
|
280
280
|
try {
|
|
281
281
|
await build(config);
|
|
282
|
-
console.log('
|
|
282
|
+
console.log('✅ Build successful');
|
|
283
283
|
} catch (error) {
|
|
284
|
-
console.error('
|
|
284
|
+
console.error('❌ Build failed:', error.message);
|
|
285
285
|
}
|
|
286
286
|
</code></pre>
|
|
287
287
|
<p>Guidelines:</p>
|
|
@@ -371,9 +371,9 @@ npx doc-builder deploy --prod
|
|
|
371
371
|
<p>Keep tables readable and well-formatted:</p>
|
|
372
372
|
<pre><code class="language-markdown">| Feature | Status | Version | Notes |
|
|
373
373
|
|---------|--------|---------|-------|
|
|
374
|
-
| Mermaid |
|
|
374
|
+
| Mermaid | ✅ Ready | 1.0.0 | Full support |
|
|
375
375
|
| Search | 🚧 WIP | 1.5.0 | In development |
|
|
376
|
-
| Auth |
|
|
376
|
+
| Auth | ✅ Ready | 1.3.0 | Optional feature |
|
|
377
377
|
</code></pre>
|
|
378
378
|
<h3>Links</h3>
|
|
379
379
|
<ul>
|
|
@@ -418,7 +418,7 @@ npx doc-builder deploy --prod
|
|
|
418
418
|
|
|
419
419
|
**Generated**: [date]
|
|
420
420
|
**Status**: Complete
|
|
421
|
-
**Verified**:
|
|
421
|
+
**Verified**: ✅
|
|
422
422
|
|
|
423
423
|
## Overview
|
|
424
424
|
What the feature does and why it exists
|
|
@@ -441,7 +441,7 @@ Common issues and solutions
|
|
|
441
441
|
|
|
442
442
|
**Generated**: [date]
|
|
443
443
|
**Status**: Complete
|
|
444
|
-
**Verified**:
|
|
444
|
+
**Verified**: ✅
|
|
445
445
|
|
|
446
446
|
## Overview
|
|
447
447
|
Technical context and goals
|
|
@@ -464,7 +464,7 @@ Benchmarks and optimization
|
|
|
464
464
|
|
|
465
465
|
**Generated**: [date]
|
|
466
466
|
**Status**: Complete
|
|
467
|
-
**Verified**:
|
|
467
|
+
**Verified**: ✅
|
|
468
468
|
|
|
469
469
|
## Overview
|
|
470
470
|
What the API does
|
|
@@ -601,6 +601,15 @@ open html/index.html
|
|
|
601
601
|
</div>
|
|
602
602
|
|
|
603
603
|
<!-- Scripts -->
|
|
604
|
+
<script>
|
|
605
|
+
// Pass configuration to frontend
|
|
606
|
+
window.docBuilderConfig = {
|
|
607
|
+
features: {
|
|
608
|
+
showPdfDownload: true,
|
|
609
|
+
menuDefaultOpen: true
|
|
610
|
+
}
|
|
611
|
+
};
|
|
612
|
+
</script>
|
|
604
613
|
<script src="/js/main.js"></script>
|
|
605
614
|
|
|
606
615
|
</body>
|