Skip to content

Commit 80cfa60

Browse files
authored
Merge pull request #28 from objectstack-ai/copilot/merge-example-into-starter
2 parents 46ec7f0 + 504ddbf commit 80cfa60

File tree

25 files changed

+297
-470
lines changed

25 files changed

+297
-470
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ This repository is a monorepo managed by pnpm workspaces:
181181

182182
## 📚 Examples
183183

184-
- **[example](./example)**: A complete standalone project demonstrating CLI-created project structure. Use this to test Vercel deployment and validate that published npm packages work correctly outside the monorepo.
184+
- **[examples/starter](./examples/starter)**: A complete starter template demonstrating the recommended project structure. Includes comprehensive documentation on architecture, testing, and deployment guides. Ready for production use on Vercel and other platforms.
185185

186186
## 🤝 Contributing
187187

example/.gitignore

Lines changed: 0 additions & 36 deletions
This file was deleted.

example/README.md

Lines changed: 0 additions & 206 deletions
This file was deleted.

example/content/docs.site.json

Lines changed: 0 additions & 23 deletions
This file was deleted.

example/content/docs/index.mdx

Lines changed: 0 additions & 45 deletions
This file was deleted.

example/content/docs/meta.json

Lines changed: 0 additions & 4 deletions
This file was deleted.

example/package.json

Lines changed: 0 additions & 14 deletions
This file was deleted.

examples/starter/.gitignore

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,36 @@
1-
node_modules
2-
.next
3-
out
4-
.env
1+
# Dependencies
2+
node_modules/
3+
.pnp
4+
.pnp.js
5+
6+
# Testing
7+
coverage/
8+
9+
# Next.js
10+
.next/
11+
out/
12+
13+
# Production
14+
build/
15+
dist/
16+
17+
# Misc
518
.DS_Store
19+
*.pem
20+
21+
# Debug
22+
npm-debug.log*
23+
yarn-debug.log*
24+
yarn-error.log*
25+
pnpm-debug.log*
26+
27+
# Local env files
28+
.env
29+
.env*.local
30+
31+
# Vercel
32+
.vercel
33+
34+
# TypeScript
35+
*.tsbuildinfo
36+
next-env.d.ts
File renamed without changes.
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,13 @@ Vercel 部署指南,包括:
6464
## 🏗️ Project Structure / 项目结构
6565

6666
```
67-
example/
67+
examples/starter/
6868
├── README.md # Main documentation
6969
├── ARCHITECTURE.md # Technical architecture details
7070
├── VERCEL.md # Vercel deployment guide
7171
├── TESTING.md # Testing guide
7272
├── validate.sh # Validation script
73-
├── package.json # Uses @objectdocs/cli from npm
73+
├── package.json # Uses @objectdocs/cli from workspace
7474
├── vercel.json # Vercel configuration
7575
├── .gitignore # Git ignore rules
7676
├── content/

0 commit comments

Comments
 (0)