Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ This repository is a monorepo managed by pnpm workspaces:

## 📚 Examples

- **[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.
- **[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.

## 🤝 Contributing

Expand Down
36 changes: 0 additions & 36 deletions example/.gitignore

This file was deleted.

206 changes: 0 additions & 206 deletions example/README.md

This file was deleted.

23 changes: 0 additions & 23 deletions example/content/docs.site.json

This file was deleted.

45 changes: 0 additions & 45 deletions example/content/docs/index.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions example/content/docs/meta.json

This file was deleted.

14 changes: 0 additions & 14 deletions example/package.json

This file was deleted.

39 changes: 35 additions & 4 deletions examples/starter/.gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,36 @@
node_modules
.next
out
.env
# Dependencies
node_modules/
.pnp
.pnp.js

# Testing
coverage/

# Next.js
.next/
out/

# Production
build/
dist/

# Misc
.DS_Store
*.pem

# Debug
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*

# Local env files
.env
.env*.local

# Vercel
.vercel

# TypeScript
*.tsbuildinfo
next-env.d.ts
File renamed without changes.
4 changes: 2 additions & 2 deletions example/INDEX.md → examples/starter/INDEX.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,13 @@ Vercel 部署指南,包括:
## 🏗️ Project Structure / 项目结构

```
example/
examples/starter/
├── README.md # Main documentation
├── ARCHITECTURE.md # Technical architecture details
├── VERCEL.md # Vercel deployment guide
├── TESTING.md # Testing guide
├── validate.sh # Validation script
├── package.json # Uses @objectdocs/cli from npm
├── package.json # Uses @objectdocs/cli from workspace
├── vercel.json # Vercel configuration
├── .gitignore # Git ignore rules
├── content/
Expand Down
Loading
Loading