Skip to content

Commit 5e58387

Browse files
Copilothuangyiirene
andcommitted
docs: add comprehensive development plan and quick start guide
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
1 parent b0a79b7 commit 5e58387

5 files changed

Lines changed: 1937 additions & 3 deletions

File tree

README.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -422,6 +422,12 @@ See our [detailed roadmap](./docs/ROADMAP.md) for upcoming features and release
422422
423423
We welcome contributions! Please read our [Contributing Guide](./CONTRIBUTING.md) for details.
424424
425+
### For Developers
426+
427+
- 📖 [Quick Start for Developers](./docs/QUICK_START_DEV.md) - Get started in 5 minutes
428+
- 📋 [Development Plan](./docs/DEVELOPMENT_PLAN.md) - Current priorities and roadmap
429+
- 🌏 [开发计划 (中文)](./docs/DEVELOPMENT_PLAN_CN.md) - Chinese version
430+
425431
### Development Setup
426432
427433
```bash
@@ -432,12 +438,15 @@ cd objectui
432438
# Install dependencies
433439
pnpm install
434440
435-
# Run tests
436-
pnpm test
437-
438441
# Build all packages
439442
pnpm build
440443
444+
# Run the showcase
445+
pnpm showcase
446+
447+
# Run tests
448+
pnpm test
449+
441450
# Run documentation site
442451
pnpm docs:dev
443452
```

docs/.vitepress/config.mts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,15 @@ export default defineConfig({
4646
{ text: 'Interactive Documentation', link: '/guide/interactive-showcase' }
4747
]
4848
},
49+
{
50+
text: 'Development',
51+
items: [
52+
{ text: 'Quick Start for Developers', link: '/QUICK_START_DEV' },
53+
{ text: 'Development Plan', link: '/DEVELOPMENT_PLAN' },
54+
{ text: '开发计划 (中文)', link: '/DEVELOPMENT_PLAN_CN' },
55+
{ text: 'Contributing Guide', link: '/CONTRIBUTING' }
56+
]
57+
},
4958
{
5059
text: 'Core Concepts',
5160
items: [

0 commit comments

Comments
 (0)