@knowcode/doc-builder 1.0.1 → 1.0.2

package/CHANGELOG.md

@@ -5,6 +5,21 @@ 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.2] - 2025-01-19
+
+### Fixed
+- Fixed remaining JUNO references in CLI help text
+- Enhanced help documentation with detailed Vercel CLI setup instructions
+- Added comprehensive deployment troubleshooting guide
+- Improved Quick Start section with step-by-step instructions
+- Added "What gets created" explanations for init command
+
+### Added
+- Requirements section in main help
+- Example for creating docs from scratch
+- Vercel installation options (npm and Homebrew)
+- Clear instructions for disabling Vercel deployment protection
+
 ## [1.0.1] - 2025-01-19
 
 ### Fixed

package/cli.js

@@ -25,7 +25,7 @@ program
   .description(packageJson.description)
   .version(packageJson.version)
   .addHelpText('before', `
-${chalk.cyan('🚀 @juno/doc-builder')} - Transform your markdown into beautiful documentation sites
+${chalk.cyan('🚀 @knowcode/doc-builder')} - Transform your markdown into beautiful documentation sites
 
 ${chalk.yellow('What it does:')}
   • Converts markdown files to static HTML with a beautiful Notion-inspired theme
@@ -34,10 +34,24 @@ ${chalk.yellow('What it does:')}
   • Deploys to Vercel with one command (zero configuration)
   • Optional authentication to protect private documentation
 
+${chalk.yellow('Requirements:')}
+  • Node.js 14+ installed
+  • A ${chalk.cyan('docs/')} folder with markdown files (or specify custom folder)
+  • Vercel CLI for deployment (optional)
+
 ${chalk.yellow('Quick Start:')}
-  ${chalk.gray('$')} npx @juno/doc-builder              ${chalk.gray('# Build and deploy to Vercel')}
-  ${chalk.gray('$')} npx @juno/doc-builder build        ${chalk.gray('# Build HTML files only')}
-  ${chalk.gray('$')} npx @juno/doc-builder dev          ${chalk.gray('# Start development server')}
+  ${chalk.cyan('1. Create your docs:')}
+     ${chalk.gray('$')} mkdir docs
+     ${chalk.gray('$')} echo "# My Documentation" > docs/README.md
+  
+  ${chalk.cyan('2. Build and deploy:')}
+     ${chalk.gray('$')} npx @knowcode/doc-builder              ${chalk.gray('# Build and deploy to Vercel')}
+     ${chalk.gray('   or')}
+     ${chalk.gray('$')} npx @knowcode/doc-builder build        ${chalk.gray('# Build HTML files only')}
+     ${chalk.gray('$')} npx @knowcode/doc-builder dev          ${chalk.gray('# Start development server')}
+
+${chalk.yellow('No docs folder yet?')}
+  ${chalk.gray('$')} npx @knowcode/doc-builder init --example  ${chalk.gray('# Create example docs')}
   `);
 
 // Build command
@@ -113,13 +127,40 @@ ${chalk.yellow('Examples:')}
   ${chalk.gray('$')} doc-builder deploy --prod          ${chalk.gray('# Deploy to production')}
   ${chalk.gray('$')} doc-builder deploy --no-build      ${chalk.gray('# Deploy existing build')}
 
-${chalk.yellow('First-time setup:')}
-  The tool will guide you through:
-  1. Installing Vercel CLI (if needed)
-  2. Creating a new Vercel project
-  3. Configuring deployment settings
+${chalk.yellow('First-time Vercel Setup:')}
+  
+  ${chalk.cyan('1. Install Vercel CLI:')}
+     ${chalk.gray('$')} npm install -g vercel
+     ${chalk.gray('   or')}
+     ${chalk.gray('$')} brew install vercel        ${chalk.gray('# macOS with Homebrew')}
+  
+  ${chalk.cyan('2. Login to Vercel:')}
+     ${chalk.gray('$')} vercel login
+     ${chalk.gray('   This will open your browser to authenticate')}
   
-${chalk.yellow('Important:')} After deployment, disable Vercel Authentication in project settings for public docs.
+  ${chalk.cyan('3. Run doc-builder deploy:')}
+     ${chalk.gray('$')} npx @knowcode/doc-builder deploy
+     
+     The tool will:
+     • Create a new Vercel project
+     • Link it to your documentation
+     • Deploy your site
+     • Provide you with a URL
+  
+  ${chalk.cyan('4. Configure Access (Important!):')} 
+     After deployment, go to your Vercel dashboard:
+     • Navigate to Project Settings → General
+     • Under "Deployment Protection", set to ${chalk.yellow('Disabled')}
+     • This allows public access to your docs
+     
+${chalk.yellow('Subsequent Deployments:')}
+  ${chalk.gray('$')} npx @knowcode/doc-builder          ${chalk.gray('# Deploy preview')}
+  ${chalk.gray('$')} npx @knowcode/doc-builder deploy --prod  ${chalk.gray('# Deploy to production')}
+
+${chalk.yellow('Troubleshooting:')}
+  • ${chalk.cyan('Command not found:')} Install Vercel CLI globally
+  • ${chalk.cyan('Not authenticated:')} Run ${chalk.gray('vercel login')}
+  • ${chalk.cyan('Project not linked:')} Delete ${chalk.gray('.vercel')} folder and redeploy
 `)
   .action(async (options) => {
     const spinner = ora('Deploying to Vercel...').start();
@@ -169,6 +210,19 @@ program
 ${chalk.yellow('Examples:')}
   ${chalk.gray('$')} doc-builder init --config          ${chalk.gray('# Create doc-builder.config.js')}
   ${chalk.gray('$')} doc-builder init --example         ${chalk.gray('# Create example docs folder')}
+  ${chalk.gray('$')} doc-builder init --example --config ${chalk.gray('# Create both')}
+
+${chalk.yellow('What gets created:')}
+  ${chalk.cyan('--example:')} Creates a docs/ folder with:
+    • README.md with welcome message and mermaid diagram
+    • getting-started.md with setup instructions
+    • guides/configuration.md with config options
+  
+  ${chalk.cyan('--config:')} Creates doc-builder.config.js with:
+    • Site name and description
+    • Feature toggles (auth, dark mode, etc.)
+    • Directory paths
+    • Authentication settings
 `)
   .action(async (options) => {
     if (options.config) {

package/package.json

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