|
1 | | -# ObjectQL Documentation |
| 1 | +--- |
| 2 | +layout: home |
2 | 3 |
|
3 | | -We have organized the documentation into multiple categories: |
| 4 | +hero: |
| 5 | + name: ObjectQL |
| 6 | + text: One Protocol, Any Database, AI-Ready |
| 7 | + tagline: A universal data query engine for the modern stack. Write your logic once in JSON-DSL, run it seamlessly on MongoDB or PostgreSQL. |
| 8 | + image: |
| 9 | + src: /logo.svg |
| 10 | + alt: ObjectQL Logo |
| 11 | + actions: |
| 12 | + - theme: brand |
| 13 | + text: Get Started |
| 14 | + link: /guide/ |
| 15 | + - theme: alt |
| 16 | + text: View on GitHub |
| 17 | + link: https://github.com/objectql/objectql |
4 | 18 |
|
5 | | -## 1. [User & Developer Guide](./guide/) |
| 19 | +features: |
| 20 | + - icon: 🚀 |
| 21 | + title: Dual-Stack Engine |
| 22 | + details: Native performance for schema-less MongoDB and first-class support for PostgreSQL, MySQL, and SQLite with a unique "Core Columns + JSONB" strategy. |
| 23 | + - icon: 🤖 |
| 24 | + title: AI-Native Protocol |
| 25 | + details: Queries defined as standardized JSON ASTs, optimized for LLMs to understand schema and generate accurate, safe business logic without hallucinating SQL syntax. |
| 26 | + - icon: ⚡ |
| 27 | + title: Modern & Lightweight |
| 28 | + details: Written in 100% TypeScript with zero heavy legacy dependencies. Promise-based asynchronous API with no runtime requirements beyond Node.js. |
| 29 | + - icon: 🔌 |
| 30 | + title: Pluggable Architecture |
| 31 | + details: Core logic completely decoupled from storage drivers. Easily extensible to support other data sources like REST APIs, GraphQL, or additional SQL/NoSQL databases. |
| 32 | + - icon: 📖 |
| 33 | + title: Comprehensive Documentation |
| 34 | + details: Detailed guides for developers and comprehensive protocol specifications for system integrators and driver contributors. |
| 35 | + - icon: 🛡️ |
| 36 | + title: Production Ready |
| 37 | + details: Built-in security features, transaction support, and optimized queries for both development flexibility and production reliability. |
| 38 | +--- |
| 39 | + |
| 40 | +## Documentation Overview |
| 41 | + |
| 42 | +We have organized the documentation into three main categories: |
| 43 | + |
| 44 | +### [User & Developer Guide](/guide/) |
6 | 45 | **Target Audience**: Application Developers, Customer Success, End Users. |
7 | | -**Content**: |
8 | | -* How to model data (Objects, Fields, Relationships). |
9 | | -* How to write business logic (Hooks, Actions). |
10 | | -* Using the Node.js SDK. |
11 | | -* Security configuration. |
12 | 46 |
|
13 | | -## 2. [Protocol Specifications](./spec/) |
| 47 | +Learn how to build applications using ObjectQL: |
| 48 | +- Data modeling (Objects, Fields, Relationships) |
| 49 | +- Writing business logic (Hooks, Actions) |
| 50 | +- Using the Node.js SDK |
| 51 | +- Security configuration |
| 52 | + |
| 53 | +### [Protocol Specifications](/spec/) |
14 | 54 | **Target Audience**: System Architects, Driver Contributors, Integrators. |
15 | | -**Content**: |
16 | | -* Metadata File Format Specification (YAML/JSON schema). |
17 | | -* Unified Query Language Protocol. |
18 | | -* Low-level HTTP API Reference. |
19 | 55 |
|
20 | | -## 3. [Airtable Functionality Roadmap](./AIRTABLE_DOCS_INDEX.md) 🆕 |
| 56 | +Understand the low-level protocols: |
| 57 | +- Metadata File Format Specification (YAML/JSON schema) |
| 58 | +- Unified Query Language Protocol |
| 59 | +- HTTP API Reference |
| 60 | + |
| 61 | +### [Airtable Functionality Roadmap](/AIRTABLE_DOCS_INDEX) 🆕 |
21 | 62 | **Target Audience**: Project Managers, Product Managers, Development Teams. |
22 | | -**Content**: |
23 | | -* [Comprehensive evaluation](./AIRTABLE_EVALUATION.md) of gaps between ObjectQL and Airtable (Chinese). |
24 | | -* [Detailed implementation roadmap](./AIRTABLE_IMPLEMENTATION_ROADMAP.md) with 6 development phases (English). |
25 | | -* [GitHub Issues templates](./GITHUB_ISSUES_TEMPLATE.md) for task creation. |
26 | | -* Resource requirements, timeline estimates, and risk assessment. |
27 | | -* Technical design proposals for multi-view system, collaboration, and automation. |
| 63 | + |
| 64 | +Comprehensive resources for implementing Airtable-like functionality: |
| 65 | +- [Comprehensive evaluation](/AIRTABLE_EVALUATION) of gaps between ObjectQL and Airtable (Chinese) |
| 66 | +- [Detailed implementation roadmap](/AIRTABLE_IMPLEMENTATION_ROADMAP) with 6 development phases (English) |
| 67 | +- [GitHub Issues templates](/GITHUB_ISSUES_TEMPLATE) for task creation |
| 68 | +- Resource requirements, timeline estimates, and risk assessment |
| 69 | +- Technical design proposals for multi-view system, collaboration, and automation |
0 commit comments