@knowcode/doc-builder 1.0.7 → 1.0.9

package/CHANGELOG.md

@@ -5,6 +5,33 @@ All notable changes to @knowcode/doc-builder will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.9] - 2025-01-19
+
+### Fixed
+- Fixed "buildCommand should be string,null" error
+- Simplified vercel.json to minimal configuration
+- Removed unnecessary buildCommand and installCommand fields
+- Only include outputDirectory in vercel.json
+
+## [1.0.8] - 2025-01-19
+
+### Added
+- Extremely prominent Root Directory warnings throughout setup
+- Red background critical warnings before setup begins
+- Clear post-setup instructions with visual formatting
+- Step-by-step Root Directory fix instructions after linking
+- Warning in help text about Root Directory configuration
+
+### Improved
+- Made Root Directory warnings impossible to miss
+- Added visual boxes and colors to critical warnings
+- Enhanced setup flow with pre-deployment warnings
+- Better formatting of post-setup instructions
+
+### Changed
+- All setup flows now show Root Directory warning first
+- Both deploy command and default flow show warnings
+
 ## [1.0.7] - 2025-01-19
 
 ### Added

package/cli.js

@@ -149,6 +149,12 @@ ${chalk.yellow('First-time Vercel Setup:')}
      ${chalk.green('Q: What is your project name?')}
      → Answer: ${chalk.yellow('Your project name')} (e.g., "my-docs" or "gasworld")
      
+     ${chalk.bgRed.white.bold(' ⚠️  CRITICAL: ABOUT ROOT DIRECTORY ')}
+     ${chalk.red('If asked about Root Directory at ANY point:')}
+     ${chalk.red('• LEAVE IT EMPTY (blank)')}
+     ${chalk.red('• DO NOT enter "html"')}
+     ${chalk.red('• We deploy FROM html folder already!')}
+     
      ${chalk.green('Q: Which framework preset?')}
      → Answer: ${chalk.yellow('Other (Static HTML)')} (always choose this)
      
@@ -243,6 +249,19 @@ ${chalk.yellow('Troubleshooting:')}
         spinner.stop();
         console.log(chalk.yellow('\n🚀 First time deploying to Vercel!\n'));
         
+        // Show critical warning about Root Directory
+        console.log(chalk.bgRed.white.bold('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━'));
+        console.log(chalk.bgRed.white.bold(' ⚠️  CRITICAL WARNING - READ BEFORE CONTINUING! '));
+        console.log(chalk.bgRed.white.bold('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n'));
+        
+        console.log(chalk.yellow.bold('During setup, if Vercel asks about Root Directory:'));
+        console.log(chalk.red.bold('• LEAVE IT EMPTY (blank)'));
+        console.log(chalk.red.bold('• DO NOT ENTER "html"'));
+        console.log(chalk.red.bold('• We are ALREADY deploying from the html folder!\n'));
+        
+        console.log(chalk.white('Setting Root Directory to "html" will cause errors.'));
+        console.log(chalk.white('You\'ll need to fix it in project settings later.\n'));
+        
         const setupConfirm = await prompts({
           type: 'confirm',
           name: 'value',
@@ -419,6 +438,16 @@ program
         deploySpinner.stop();
         console.log(chalk.yellow('\n🚀 First time deploying to Vercel!\n'));
         
+        // Show critical warning about Root Directory
+        console.log(chalk.bgRed.white.bold('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━'));
+        console.log(chalk.bgRed.white.bold(' ⚠️  CRITICAL WARNING - READ BEFORE CONTINUING! '));
+        console.log(chalk.bgRed.white.bold('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n'));
+        
+        console.log(chalk.yellow.bold('During setup, if Vercel asks about Root Directory:'));
+        console.log(chalk.red.bold('• LEAVE IT EMPTY (blank)'));
+        console.log(chalk.red.bold('• DO NOT ENTER "html"'));
+        console.log(chalk.red.bold('• We are ALREADY deploying from the html folder!\n'));
+        
         const setupConfirm = await prompts({
           type: 'confirm',
           name: 'value',

package/lib/deploy.js

@@ -58,13 +58,10 @@ async function setupVercelProject(config) {
     fs.mkdirSync(outputDir, { recursive: true });
   }
   
-  // Create vercel.json for static site
-  // Use empty string instead of false to avoid Vercel issues
+  // Create minimal vercel.json for static site
+  // Only include required fields
   const vercelConfig = {
-    buildCommand: "",
-    outputDirectory: ".",
-    installCommand: "",
-    framework: null
+    outputDirectory: "."
   };
   
   fs.writeJsonSync(vercelConfigPath, vercelConfig, { spaces: 2 });
@@ -93,6 +90,12 @@ async function setupVercelProject(config) {
   console.log(chalk.white('5️⃣  ') + chalk.green('What\'s the name of your existing project?'));
   console.log(chalk.white('   👉 Answer: ') + chalk.yellow.bold(answers.projectName) + ' (your actual project name)\n');
   
+  console.log(chalk.red.bold('⚠️  CRITICAL WARNING ABOUT ROOT DIRECTORY:\n'));
+  console.log(chalk.bgRed.white.bold(' If Vercel asks about Root Directory or shows it in settings: '));
+  console.log(chalk.bgRed.white.bold(' LEAVE IT COMPLETELY EMPTY! DO NOT ENTER "html"! '));
+  console.log(chalk.white('\nWe are already in the html folder - setting Root Directory'));
+  console.log(chalk.white('to "html" will cause "html/html does not exist" errors!\n'));
+  
   console.log(chalk.blue('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n'));
   
   try {
@@ -107,14 +110,27 @@ async function setupVercelProject(config) {
   }
   
   // Important reminders for Vercel settings
-  console.log(chalk.yellow('\n⚠️  IMPORTANT: Vercel Project Settings\n'));
-  console.log(chalk.white('After deployment, go to your Vercel dashboard:'));
-  console.log();
-  console.log(chalk.red.bold('🔴 CRITICAL: Check Root Directory Setting'));
-  console.log(chalk.white('1. Go to: ') + chalk.cyan(`https://vercel.com/${answers.projectName}/settings`));
-  console.log(chalk.white('2. Under "Build & Development Settings"'));
-  console.log(chalk.white('3. Make sure "Root Directory" is ') + chalk.yellow.bold('EMPTY or "./"'));
-  console.log(chalk.white('   (NOT "html" or any other directory)'));
+  console.log(chalk.red('\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━'));
+  console.log(chalk.red.bold('🚨 CRITICAL POST-SETUP STEP - DO THIS NOW!'));
+  console.log(chalk.red('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n'));
+  
+  console.log(chalk.yellow.bold('Vercel may have set Root Directory incorrectly!\n'));
+  
+  console.log(chalk.white.bold('1. GO TO YOUR PROJECT SETTINGS NOW:'));
+  console.log(chalk.cyan(`   https://vercel.com/${answers.projectName}/settings\n`));
+  
+  console.log(chalk.white.bold('2. Find "Root Directory" under "Build & Development Settings"\n'));
+  
+  console.log(chalk.white.bold('3. CHECK THE VALUE:'));
+  console.log(chalk.green('   ✅ CORRECT: ') + chalk.green.bold('Empty (blank) or "./"'));
+  console.log(chalk.red('   ❌ WRONG: ') + chalk.red.bold('"html" or any other value\n'));
+  
+  console.log(chalk.white.bold('4. IF IT SAYS "html":'));
+  console.log(chalk.yellow('   • DELETE the value completely'));
+  console.log(chalk.yellow('   • Leave it EMPTY'));
+  console.log(chalk.yellow('   • Click SAVE\n'));
+  
+  console.log(chalk.bgRed.white.bold(' Failure to do this will cause deployment errors! '));
   console.log();
   console.log(chalk.yellow('🔐 For Public Access:'));
   console.log(chalk.white('1. Navigate to Project Settings > General'));
@@ -178,11 +194,9 @@ async function deployToVercel(config, isProd = false) {
   // Create vercel.json in output directory for deployment
   const vercelConfigPath = path.join(outputPath, 'vercel.json');
   if (!fs.existsSync(vercelConfigPath)) {
+    // Create minimal vercel.json for static site
     const vercelConfig = {
-      buildCommand: "",
-      outputDirectory: ".",
-      installCommand: "",
-      framework: null
+      outputDirectory: "."
     };
     fs.writeJsonSync(vercelConfigPath, vercelConfig, { spaces: 2 });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowcode/doc-builder",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "Reusable documentation builder for markdown-based sites with Vercel deployment support",
   "main": "index.js",
   "bin": {