Skip to content

Commit 3c9a226

Browse files
authored
Merge pull request #99 from objectstack-ai/copilot/update-documentation-again
2 parents 71dc588 + 817a2e8 commit 3c9a226

File tree

12 files changed

+1523
-24
lines changed

12 files changed

+1523
-24
lines changed

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -422,6 +422,11 @@ 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+
425430
### Development Setup
426431
427432
```bash
@@ -432,12 +437,15 @@ cd objectui
432437
# Install dependencies
433438
pnpm install
434439
435-
# Run tests
436-
pnpm test
437-
438440
# Build all packages
439441
pnpm build
440442
443+
# Run the showcase
444+
pnpm showcase
445+
446+
# Run tests
447+
pnpm test
448+
441449
# Run documentation site
442450
pnpm docs:dev
443451
```

docs/.vitepress/config.mts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,14 @@ 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: 'Contributing Guide', link: '/CONTRIBUTING' }
55+
]
56+
},
4957
{
5058
text: 'Core Concepts',
5159
items: [

docs/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,20 @@ This directory contains the VitePress documentation site for Object UI.
44

55
## Quick Links
66

7+
### For Users
78
- 🏠 [Homepage](./index.md)
89
- 📖 [Getting Started Guide](./guide/introduction.md)
910
- 🚀 [Quick Start](./guide/quick-start.md)
1011
- 📦 [Installation](./guide/installation.md)
1112
- 🎨 [Visual Studio](./guide/studio.md)
1213
- 🗺️ [Roadmap](./ROADMAP.md)
1314

15+
### For Developers
16+
-[Quick Start for Developers](./quick-start-dev.md) - Get started in 5 minutes
17+
- 📋 [Development Plan](./development-plan.md) - Q1-Q2 2026 priorities and roadmap
18+
- 🤝 [Contributing Guide](../CONTRIBUTING.md) - How to contribute
19+
- 📚 [Best Practices](./BEST_PRACTICES.md) - Code quality guidelines
20+
1421
## Documentation Structure
1522

1623
```

0 commit comments

Comments
 (0)