@knowcode/doc-builder 1.0.6 → 1.0.8

package/CHANGELOG.md

@@ -5,6 +5,44 @@ 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.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
+- New `reset-vercel` command to fix deployment issues
+- Pre-deployment warning about Root Directory settings
+- Automatic detection of "html/html does not exist" error with clear fix instructions
+- Visual deployment status with project information
+- Better error messages that extract and show the settings URL
+
+### Improved
+- Enhanced error handling with specific instructions for Root Directory issues
+- Clear visual separation for deployment warnings
+- More prominent pre-deployment checks
+- Direct links to Vercel project settings
+
+### Fixed
+- Better handling of the common "html/html" path error
+- Clearer recovery instructions when deployment fails
+
 ## [1.0.6] - 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',
@@ -272,6 +291,48 @@ ${chalk.yellow('Troubleshooting:')}
     }
   });
 
+// Reset command for Vercel issues
+program
+  .command('reset-vercel')
+  .description('Reset Vercel configuration (fixes common deployment issues)')
+  .option('-c, --config <path>', 'path to config file (default: doc-builder.config.js)')
+  .addHelpText('after', `
+${chalk.yellow('What this does:')}
+  • Removes .vercel folder from your output directory
+  • Lets you set up a fresh Vercel project
+  • Fixes "html/html does not exist" errors
+  • Fixes wrong project linking issues
+
+${chalk.yellow('When to use:')}
+  • After "html/html does not exist" error
+  • When linked to wrong project (e.g., username/html)
+  • When Root Directory settings are incorrect
+`)
+  .action(async (options) => {
+    try {
+      const config = await loadConfig(options.config || 'doc-builder.config.js', options);
+      const outputPath = path.join(process.cwd(), config.outputDir || 'html');
+      const vercelPath = path.join(outputPath, '.vercel');
+      
+      if (fs.existsSync(vercelPath)) {
+        console.log(chalk.yellow('🗑️  Removing .vercel folder from ' + config.outputDir + '...'));
+        fs.removeSync(vercelPath);
+        console.log(chalk.green('✅ Vercel configuration reset!'));
+        console.log(chalk.gray('\nNow run deployment again:'));
+        console.log(chalk.cyan('  npx @knowcode/doc-builder deploy'));
+        console.log(chalk.gray('\nThis time:'));
+        console.log(chalk.gray('• Create a NEW project (not username/html)'));
+        console.log(chalk.gray('• Use a descriptive name like "my-docs"'));
+        console.log(chalk.gray('• Leave Root Directory EMPTY'));
+      } else {
+        console.log(chalk.gray('No .vercel folder found. Ready for fresh deployment!'));
+      }
+    } catch (error) {
+      console.error(chalk.red(error.message));
+      process.exit(1);
+    }
+  });
+
 // Init command
 program
   .command('init')
@@ -377,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

@@ -93,6 +93,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 +113,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'));
@@ -145,14 +164,31 @@ async function deployToVercel(config, isProd = false) {
     throw new Error(`Output directory ${outputPath} does not exist. Run 'doc-builder build' first.`);
   }
   
-  // Check for existing project link
+  // Check for existing project link and warn about common issues
   const vercelProjectPath = path.join(outputPath, '.vercel', 'project.json');
   if (fs.existsSync(vercelProjectPath)) {
     try {
       const projectInfo = fs.readJsonSync(vercelProjectPath);
-      console.log(chalk.yellow('\n⚠️  Deploying to existing project: ') + chalk.cyan(projectInfo.projectId || 'unknown'));
-      console.log(chalk.yellow('If deployment fails with path errors, check your Root Directory setting:'));
-      console.log(chalk.cyan(`https://vercel.com/dashboard/project/${projectInfo.projectId || 'settings'}\n`));
+      const projectId = projectInfo.projectId || 'unknown';
+      
+      console.log(chalk.blue('\n━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━'));
+      console.log(chalk.yellow('📦 Deploying to existing Vercel project'));
+      console.log(chalk.blue('━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━\n'));
+      
+      console.log(chalk.white('Project ID: ') + chalk.cyan(projectId));
+      
+      // Check if .vercel/project.json has rootDirectory set
+      if (projectInfo.settings && projectInfo.settings.rootDirectory) {
+        console.log(chalk.red.bold('\n⚠️  WARNING: Root Directory is set to: ') + chalk.yellow(projectInfo.settings.rootDirectory));
+        console.log(chalk.red('This may cause deployment to fail!\n'));
+      }
+      
+      console.log(chalk.yellow.bold('\n⚡ BEFORE CONTINUING:'));
+      console.log(chalk.white('1. Check your Root Directory setting at:'));
+      console.log(chalk.cyan(`   https://vercel.com/dashboard/project/${projectId}`));
+      console.log(chalk.white('2. Root Directory should be ') + chalk.green.bold('EMPTY (blank)'));
+      console.log(chalk.white('3. If it says "html", ') + chalk.red.bold('DELETE IT NOW!\n'));
+      
     } catch (e) {
       // Ignore read errors
     }
@@ -186,6 +222,23 @@ async function deployToVercel(config, isProd = false) {
     
     return deployUrl;
   } catch (error) {
+    // Check if this is the common "html/html" path error
+    if (error.message && error.message.includes('html/html') && error.message.includes('does not exist')) {
+      console.log(chalk.red.bold('\n❌ ERROR: Vercel has incorrect Root Directory settings!\n'));
+      console.log(chalk.yellow('The project is configured with Root Directory = "html"'));
+      console.log(chalk.yellow('But we are already deploying FROM the html directory.\n'));
+      
+      console.log(chalk.green.bold('🔧 TO FIX THIS:\n'));
+      console.log(chalk.white('1. Go to: ') + chalk.cyan(error.message.match(/https:\/\/vercel\.com\/[^\s]+/)?.[0] || 'https://vercel.com/dashboard'));
+      console.log(chalk.white('2. Find "Root Directory" under "Build & Development Settings"'));
+      console.log(chalk.white('3. ') + chalk.yellow.bold('DELETE the "html" value (leave it EMPTY)'));
+      console.log(chalk.white('4. Click "Save"'));
+      console.log(chalk.white('5. Run this command again\n'));
+      
+      console.log(chalk.gray('Alternative: Delete html/.vercel folder and set up fresh'));
+      
+      throw new Error('Root Directory misconfiguration - see instructions above');
+    }
     throw new Error(`Vercel deployment failed: ${error.message}`);
   }
 }

package/package.json

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