Skip to content
Merged
Show file tree
Hide file tree
Changes from 7 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
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -422,6 +422,11 @@ See our [detailed roadmap](./docs/ROADMAP.md) for upcoming features and release

We welcome contributions! Please read our [Contributing Guide](./CONTRIBUTING.md) for details.

### For Developers

- 📖 [Quick Start for Developers](./docs/quick-start-dev.md) - Get started in 5 minutes
- 📋 [Development Plan](./docs/development-plan.md) - Current priorities and roadmap

### Development Setup

```bash
Expand All @@ -432,12 +437,15 @@ cd objectui
# Install dependencies
pnpm install

# Run tests
pnpm test

# Build all packages
pnpm build

# Run the showcase
pnpm showcase

# Run tests
pnpm test

# Run documentation site
pnpm docs:dev
```
Expand Down
8 changes: 8 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,14 @@ export default defineConfig({
{ text: 'Interactive Documentation', link: '/guide/interactive-showcase' }
]
},
{
text: 'Development',
items: [
{ text: 'Quick Start for Developers', link: '/quick-start-dev' },
{ text: 'Development Plan', link: '/development-plan' },
{ text: 'Contributing Guide', link: '/CONTRIBUTING' }
]
},
{
text: 'Core Concepts',
items: [
Expand Down
7 changes: 7 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,20 @@ This directory contains the VitePress documentation site for Object UI.

## Quick Links

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

### For Developers
- ⚡ [Quick Start for Developers](./quick-start-dev.md) - Get started in 5 minutes
- 📋 [Development Plan](./development-plan.md) - Q1-Q2 2026 priorities and roadmap
- 🤝 [Contributing Guide](../CONTRIBUTING.md) - How to contribute
- 📚 [Best Practices](./BEST_PRACTICES.md) - Code quality guidelines

## Documentation Structure

```
Expand Down
Loading
Loading