Skip to content

Commit 31ae310

Browse files
authored
Merge pull request #148 from objectstack-ai/copilot/optimize-document-structure
2 parents 4a494ed + a3517ac commit 31ae310

40 files changed

+3665
-4549
lines changed

README.md

Lines changed: 46 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -318,36 +318,57 @@ class MyCustomDataSource implements DataSource {
318318
319319
## 📚 Documentation
320320
321+
Visit [**objectui.org**](https://www.objectui.org) for complete documentation.
322+
321323
### Getting Started
322-
- [Introduction](./docs/guide/introduction.md) - Learn what Object UI is and why it exists
323324
- [Quick Start](./docs/guide/quick-start.md) - Build your first app in 5 minutes
324325
- [Installation](./docs/guide/installation.md) - Detailed setup instructions
325-
- [Visual Studio](./docs/guide/studio.md) - Use the drag-and-drop designer
326+
- [Showcase](./docs/guide/showcase.md) - Interactive component gallery
327+
- [CLI Guide](./docs/guide/cli/getting-started.md) - Using the ObjectUI CLI
328+
- [Visual Studio](./docs/guide/studio.md) - Drag-and-drop designer
326329
327330
### Core Concepts
328-
- [Schema Rendering](./docs/spec/schema-rendering.md) - Understand the rendering system
329-
- [Architecture](./docs/spec/architecture.md) - Technical architecture overview
330-
- [Component System](./docs/spec/component.md) - How components work
331-
332-
### Data Integration
333-
- [ObjectQL Integration](./docs/integration/objectql.md) - Connect to ObjectQL backends
334-
- [Custom Data Sources](./packages/types/examples/rest-data-source.ts) - Build your own adapters
331+
- [Schema Rendering](./docs/concepts/schema-rendering.md) - How the rendering system works
332+
- [Expressions](./docs/concepts/expressions.md) - Dynamic values and conditions
333+
- [Data Sources](./docs/concepts/data-source.md) - Connecting to APIs
334+
- [Component Registry](./docs/concepts/component-registry.md) - Registering custom components
335+
- [Plugins](./docs/concepts/plugins.md) - Extending ObjectUI
335336
336-
### Protocol Specifications
337-
- [Protocol Overview](./docs/protocol/overview.md) - Complete protocol reference
338-
- [Form Protocol](./docs/protocol/form.md) - Form schema specification
339-
- [View Protocol](./docs/protocol/view.md) - Data view specifications
340-
- [Page Protocol](./docs/protocol/page.md) - Page layout specifications
337+
### Components & Plugins
338+
- [Component Library](./docs/components/) - Browse all available components
339+
- [Charts Plugin](./docs/plugins/plugin-charts.mdx) - Chart components
340+
- [Kanban Plugin](./docs/plugins/plugin-kanban.mdx) - Kanban boards
341341
342342
### API Reference
343-
- [Core API](./docs/api/core.md) - `@object-ui/core` API reference
344-
- [React API](./docs/api/react.md) - `@object-ui/react` API reference
345-
- [Components API](./docs/api/components.md) - Component library reference
346-
- [Designer API](./docs/api/designer.md) - Visual designer API
343+
- [Core API](./docs/reference/api/core.md) - `@object-ui/core` API
344+
- [React API](./docs/reference/api/react.md) - `@object-ui/react` API
345+
- [Components API](./docs/reference/api/components.md) - Component library API
346+
- [Designer API](./docs/reference/api/designer.md) - Visual designer API
347347
348-
### Advanced
349-
- [Lazy-Loaded Plugins](./docs/lazy-loaded-plugins.md) - Plugin architecture
350-
- [Component Packages](./docs/spec/component-package.md) - Creating custom components
348+
### Protocol Specifications
349+
- [Protocol Overview](./docs/reference/protocol/overview.md) - Complete protocol reference
350+
- [Page Protocol](./docs/reference/protocol/page.md) - Page schema specification
351+
- [Form Protocol](./docs/reference/protocol/form.md) - Form schema specification
352+
- [View Protocol](./docs/reference/protocol/view.md) - Data view specifications
353+
- [CRUD Protocol](./docs/reference/protocol/crud.md) - CRUD operations
354+
355+
### Architecture & Advanced
356+
- [Architecture](./docs/architecture/architecture.md) - System architecture overview
357+
- [Project Structure](./docs/architecture/project-structure.md) - Code organization
358+
- [Component System](./docs/architecture/component.md) - How components work
359+
- [Rendering Specification](./docs/architecture/rendering-specification.md) - Technical rendering spec
360+
361+
### Ecosystem & Integration
362+
- [ObjectQL Integration](./docs/ecosystem/objectql.md) - Connect to ObjectQL backends
363+
- [API Integration](./docs/ecosystem/api.md) - REST API integration
364+
- [Deployment](./docs/ecosystem/deployment/showcase-deployment.md) - Deploy to production
365+
366+
### Support & Resources
367+
- [FAQ](./docs/faq.md) - Frequently asked questions
368+
- [Troubleshooting](./docs/troubleshooting/index.md) - Common issues and solutions
369+
- [Security](./docs/security.md) - Security best practices
370+
- [Migration Guide](./docs/migration/from-objectstack.md) - Migrating from ObjectStack
371+
- [Examples](./docs/examples.md) - Learn from real-world examples
351372
352373
## 🎯 What Can You Build?
353374
@@ -405,7 +426,7 @@ pnpm designer
405426
406427
## 🛣️ Roadmap
407428
408-
See our [detailed roadmap](./docs/ROADMAP.md) for upcoming features and release timeline.
429+
See our [detailed roadmap](./docs/community/roadmap.md) for upcoming features and release timeline.
409430
410431
**Q1 2026** (Available March 2026):
411432
- ✅ Core schema rendering
@@ -425,8 +446,9 @@ We welcome contributions! Please read our [Contributing Guide](./CONTRIBUTING.md
425446
426447
### For Developers
427448
428-
- 📖 [Quick Start for Developers](./docs/quick-start-dev.md) - Get started in 5 minutes
429-
- 📋 [Development Plan](./docs/development-plan.md) - Current priorities and roadmap
449+
- 📖 [Contributing Guide](./CONTRIBUTING.md) - How to contribute to the project
450+
- 🏗️ [Architecture](./docs/architecture/architecture.md) - Technical architecture
451+
- 📚 [Best Practices](./docs/community/best-practices.md) - Code quality guidelines
430452
431453
### Development Setup
432454
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/architecture/meta.json

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"title": "Architecture",
3+
"pages": [
4+
"architecture",
5+
"project-structure",
6+
"rendering-specification",
7+
"component",
8+
"component-library",
9+
"component-package",
10+
"base-components"
11+
]
12+
}
File renamed without changes.
File renamed without changes.

docs/community/architecture/objectstack-spec-integration.md

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

0 commit comments

Comments
 (0)