Skip to content

Commit 504ddbf

Browse files
Copilothuangyiirene
andcommitted
Address code review feedback: improve validation script and docs
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
1 parent 911f985 commit 504ddbf

File tree

3 files changed

+8
-6
lines changed

3 files changed

+8
-6
lines changed

examples/starter/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,11 +127,13 @@ vercel
127127

128128
### Vercel Configuration
129129

130-
No special configuration is needed. Vercel will automatically:
130+
This project includes a `vercel.json` file with Next.js framework detection. Vercel will automatically:
131131
- Detect the Next.js framework
132132
- Use `pnpm build` (via `objectdocs build`) as the build command
133133
- Use the `.next` directory as the output
134134

135+
For more details on Vercel deployment, see [VERCEL.md](./VERCEL.md).
136+
135137
## ✅ Testing Checklist
136138

137139
Use this checklist to validate the starter works correctly:

examples/starter/TESTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ This method is closer to how users would install from npm:
4848
```bash
4949
cd packages/cli
5050
pnpm pack
51-
# This creates objectdocs-cli-0.2.11.tgz
51+
# This creates objectdocs-cli-X.X.X.tgz (where X.X.X is the current version)
5252
```
5353

5454
2. Create a test directory:
@@ -62,7 +62,7 @@ cd /tmp/test-standalone
6262

6363
```bash
6464
pnpm init
65-
pnpm add -D ../path/to/objectdocs-cli-0.2.11.tgz
65+
pnpm add -D ../path/to/objectdocs-cli-X.X.X.tgz
6666
```
6767

6868
4. Copy the content structure:

examples/starter/validate.sh

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ GREEN='\033[0;32m'
1515
YELLOW='\033[1;33m'
1616
NC='\033[0m' # No Color
1717

18-
# Check if we're in the starter directory
19-
if [ ! -f "package.json" ] || ! grep -q "objectdocs-starter" package.json; then
20-
echo -e "${RED}Error: This script must be run from the examples/starter directory${NC}"
18+
# Check if we're in an ObjectDocs project directory
19+
if [ ! -f "package.json" ] || ! grep -q "@objectdocs/cli" package.json; then
20+
echo -e "${RED}Error: This script must be run from an ObjectDocs project directory${NC}"
2121
exit 1
2222
fi
2323

0 commit comments

Comments
 (0)