@knowcode/doc-builder 1.5.11 → 1.5.12

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 (3) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README.md +13 -12
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -5,6 +5,23 @@ All notable changes to @knowcode/doc-builder will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
+ ## [1.5.12] - 2025-07-22
9
+
10
+ ### Documentation
11
+ - 📚 **Updated all Vercel documentation** for the simplified setup process
12
+ - ✨ **Rewrote vercel-first-time-setup-guide.md** with streamlined 6-step process
13
+ - 🔧 **Updated vercel-cli-setup-guide.md** to focus on installation and advanced usage
14
+ - 📝 **Simplified README.md deployment section** to 4 clear steps
15
+ - 🐛 **Updated troubleshooting-guide.md** with new deployment solutions
16
+ - 🎯 **Removed references to complex prompts** and confusing options
17
+ - 📖 **Added 'What Changed' section** highlighting improvements
18
+
19
+ ### Documentation Improvements
20
+ - No more confusing "Found project xyz/html" prompts
21
+ - No more root directory confusion
22
+ - Clear, straightforward deployment flow
23
+ - Better error messages and solutions
24
+
8
25
  ## [1.5.11] - 2025-07-22
9
26
 
10
27
  ### Fixed
package/README.md CHANGED
@@ -86,22 +86,23 @@ doc-builder deploy
86
86
 
87
87
  ## First-Time Vercel Deployment
88
88
 
89
- When deploying for the first time, doc-builder will:
89
+ The deployment process is now simpler than ever:
90
90
 
91
- 1. Check if Vercel CLI is installed
92
- 2. Guide you through project setup
93
- 3. Create `vercel.json` configuration
94
- 4. Link your project to Vercel
95
- 5. Show important reminders about Vercel settings
91
+ 1. Run `npx @knowcode/doc-builder deploy`
92
+ 2. Answer a few simple questions (project name, etc.)
93
+ 3. Vercel CLI automatically detects and configures everything
94
+ 4. Get your live URL in seconds!
96
95
 
97
- ### Important Vercel Settings
96
+ ### Making Your Docs Public
98
97
 
99
- After deployment, go to your Vercel dashboard:
98
+ After deployment, if you want public access:
100
99
 
101
- 1. Navigate to **Project Settings > General**
102
- 2. Under **Security**, find **Deployment Protection**
103
- 3. Set to **Disabled** for public access
104
- 4. Or configure authentication for private docs
100
+ 1. Go to [Vercel Dashboard](https://vercel.com/dashboard)
101
+ 2. Click your project → Settings → Deployment Protection
102
+ 3. Set **Vercel Authentication** to **Disabled**
103
+ 4. Save changes
104
+
105
+ See the [First-Time Setup Guide](docs/vercel-first-time-setup-guide.md) for a complete walkthrough.
105
106
 
106
107
  ## Configuration (optional - can be managed with CLI)
107
108
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@knowcode/doc-builder",
3
- "version": "1.5.11",
3
+ "version": "1.5.12",
4
4
  "description": "Reusable documentation builder for markdown-based sites with Vercel deployment support",
5
5
  "main": "index.js",
6
6
  "bin": {