Skip to content

Commit 6b16fd8

Browse files
Copilothuangyiirene
andcommitted
Add ObjectStack company and product documentation (ObjectUI, ObjectQL, ObjectOS)
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
1 parent a1e0e8c commit 6b16fd8

13 files changed

Lines changed: 247 additions & 27 deletions

app/layout.config.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import { type BaseLayoutProps } from 'fumadocs-ui/layouts/shared';
22

33
export const baseOptions: BaseLayoutProps = {
44
nav: {
5-
title: 'My Docs',
5+
title: 'ObjectStack',
66
},
77
links: [
88
{
Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
11
---
22
title: Getting Started
3-
description: Learn how to get started with this documentation
3+
description: Learn how to get started with ObjectStack products
44
---
55

66
# Getting Started
77

8-
This guide will help you get started with our documentation.
8+
This guide will help you get started with ObjectStack and its products.
99

10-
## Installation
10+
## About ObjectStack
1111

12-
To use this documentation site locally:
12+
ObjectStack provides three powerful products for building modern applications:
1313

14-
```bash
15-
npm install
16-
npm run dev
17-
```
14+
- **[ObjectUI](/docs/objectui)**: UI component library for beautiful interfaces
15+
- **[ObjectQL](/docs/objectql)**: Query language and data access layer
16+
- **[ObjectOS](/docs/objectos)**: Operating system framework for scalable applications
1817

19-
## Navigation
18+
## Documentation Navigation
2019

2120
Use the sidebar to navigate through different sections. The search bar at the top allows you to quickly find specific topics.
2221

2322
## Language Support
2423

2524
Click on the language selector in the navigation bar to switch between English and Chinese.
25+
26+
## Next Steps
27+
28+
Explore each product's documentation to learn more about their features and how to use them in your projects.
Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
11
---
22
title: 快速开始
3-
description: 了解如何开始使用本文档
3+
description: 了解如何开始使用 ObjectStack 产品
44
---
55

66
# 快速开始
77

8-
本指南将帮助您开始使用我们的文档
8+
本指南将帮助您开始使用 ObjectStack 及其产品
99

10-
## 安装
10+
## 关于 ObjectStack
1111

12-
要在本地使用此文档网站
12+
ObjectStack 提供三个强大的产品用于构建现代应用程序
1313

14-
```bash
15-
npm install
16-
npm run dev
17-
```
14+
- **[ObjectUI](/docs/objectui)**:用于美观界面的 UI 组件库
15+
- **[ObjectQL](/docs/objectql)**:查询语言和数据访问层
16+
- **[ObjectOS](/docs/objectos)**:用于可扩展应用程序的操作系统框架
1817

19-
## 导航
18+
## 文档导航
2019

2120
使用侧边栏浏览不同的部分。顶部的搜索栏可以让您快速找到特定主题。
2221

2322
## 语言支持
2423

2524
点击导航栏中的语言选择器,在英语和中文之间切换。
25+
26+
## 下一步
27+
28+
探索每个产品的文档,了解更多关于它们的功能以及如何在您的项目中使用它们。

content/docs/index.en.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
---
22
title: Welcome
3-
description: Welcome to the documentation
3+
description: Welcome to ObjectStack Documentation
44
---
55

6-
# Welcome to Our Documentation
6+
# Welcome to ObjectStack
77

8-
This is a documentation site built with Fumadocs that supports internationalization.
8+
ObjectStack is a comprehensive platform for building modern applications with powerful tools and frameworks.
9+
10+
## Our Products
11+
12+
We offer three core products designed to streamline your development workflow:
13+
14+
- **ObjectUI**: A modern UI component library for building beautiful and responsive user interfaces
15+
- **ObjectQL**: A powerful query language and data access layer for efficient data operations
16+
- **ObjectOS**: An operating system framework that provides the foundation for building scalable applications
917

1018
## Features
1119

content/docs/index.zh-CN.mdx

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,19 @@
11
---
22
title: 欢迎
3-
description: 欢迎访问文档
3+
description: 欢迎访问 ObjectStack 文档
44
---
55

6-
# 欢迎访问我们的文档
6+
# 欢迎访问 ObjectStack
77

8-
这是一个使用 Fumadocs 构建的文档网站,支持国际化。
8+
ObjectStack 是一个综合性平台,提供强大的工具和框架来构建现代应用程序。
9+
10+
## 我们的产品
11+
12+
我们提供三个核心产品,旨在简化您的开发工作流程:
13+
14+
- **ObjectUI**:现代化的 UI 组件库,用于构建美观且响应式的用户界面
15+
- **ObjectQL**:强大的查询语言和数据访问层,用于高效的数据操作
16+
- **ObjectOS**:操作系统框架,为构建可扩展应用程序提供基础
917

1018
## 特性
1119

content/docs/meta.en.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"title": "Documentation",
3-
"pages": ["index", "getting-started", "i18n-guide"]
3+
"pages": ["index", "getting-started", "objectui", "objectql", "objectos", "i18n-guide"]
44
}

content/docs/meta.zh-CN.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
22
"title": "文档",
3-
"pages": ["index", "getting-started", "i18n-guide"]
3+
"pages": ["index", "getting-started", "objectui", "objectql", "objectos", "i18n-guide"]
44
}

content/docs/objectos.en.mdx

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: ObjectOS
3+
description: Operating system framework for building scalable applications
4+
---
5+
6+
# ObjectOS
7+
8+
ObjectOS is a comprehensive operating system framework that provides the foundation and infrastructure for building scalable, enterprise-grade applications.
9+
10+
## Overview
11+
12+
ObjectOS offers a complete platform with built-in services, APIs, and tools that accelerate application development. It handles the complexity of infrastructure management, allowing developers to focus on building business features.
13+
14+
## Key Features
15+
16+
- **Microservices Architecture**: Built-in support for microservices patterns
17+
- **Service Discovery**: Automatic service registration and discovery
18+
- **API Gateway**: Unified API gateway for routing and security
19+
- **Authentication & Authorization**: Comprehensive security framework
20+
- **Data Management**: Integrated data storage and caching solutions
21+
- **Monitoring & Logging**: Built-in observability tools
22+
- **Scalability**: Horizontal and vertical scaling capabilities
23+
- **Multi-tenancy**: Native support for multi-tenant applications
24+
25+
## Use Cases
26+
27+
- Building enterprise applications
28+
- Creating SaaS platforms
29+
- Developing microservices architectures
30+
- Implementing multi-tenant systems
31+
32+
## Getting Started
33+
34+
To start using ObjectOS in your project, check out our [Getting Started](/docs/getting-started) guide.

content/docs/objectos.zh-CN.mdx

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: ObjectOS
3+
description: 用于构建可扩展应用程序的操作系统框架
4+
---
5+
6+
# ObjectOS
7+
8+
ObjectOS 是一个全面的操作系统框架,为构建可扩展的企业级应用程序提供基础和基础设施。
9+
10+
## 概述
11+
12+
ObjectOS 提供了一个完整的平台,包含内置服务、API 和工具,可加速应用程序开发。它处理基础设施管理的复杂性,使开发人员能够专注于构建业务功能。
13+
14+
## 主要特性
15+
16+
- **微服务架构**:内置支持微服务模式
17+
- **服务发现**:自动服务注册和发现
18+
- **API 网关**:用于路由和安全的统一 API 网关
19+
- **认证与授权**:全面的安全框架
20+
- **数据管理**:集成的数据存储和缓存解决方案
21+
- **监控与日志**:内置的可观测性工具
22+
- **可扩展性**:水平和垂直扩展能力
23+
- **多租户**:原生支持多租户应用程序
24+
25+
## 使用场景
26+
27+
- 构建企业应用程序
28+
- 创建 SaaS 平台
29+
- 开发微服务架构
30+
- 实现多租户系统
31+
32+
## 开始使用
33+
34+
要在您的项目中开始使用 ObjectOS,请查看我们的[开始使用](/docs/getting-started)指南。

content/docs/objectql.en.mdx

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: ObjectQL
3+
description: Powerful query language and data access layer
4+
---
5+
6+
# ObjectQL
7+
8+
ObjectQL is a powerful query language and data access layer that simplifies data operations and provides efficient data management capabilities for your applications.
9+
10+
## Overview
11+
12+
ObjectQL enables developers to interact with data using a flexible and intuitive query language. It provides a unified interface for data operations across different data sources and storage systems.
13+
14+
## Key Features
15+
16+
- **Intuitive Query Syntax**: Easy-to-learn query language similar to SQL
17+
- **Multi-Database Support**: Connect to various database systems
18+
- **Type Safety**: Strong typing for query results
19+
- **Performance Optimized**: Efficient query execution and caching
20+
- **Real-time Operations**: Support for real-time data updates
21+
- **GraphQL Compatible**: Can integrate with GraphQL APIs
22+
- **Transaction Support**: ACID-compliant transactions
23+
24+
## Use Cases
25+
26+
- Building data-driven applications
27+
- Creating APIs for data access
28+
- Implementing complex business logic
29+
- Managing multi-tenant data architectures
30+
31+
## Getting Started
32+
33+
To start using ObjectQL in your project, check out our [Getting Started](/docs/getting-started) guide.

0 commit comments

Comments
 (0)