Skip to content

Commit d9b861b

Browse files
Copilothotlong
andcommitted
Update example documentation titles and descriptions
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 6fa9783 commit d9b861b

5 files changed

Lines changed: 9 additions & 13 deletions

File tree

docs/examples/README_CN.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# 附件 API 实现文档
1+
# Attachment API Implementation Guide (Chinese)
22

3-
## 概述
4-
5-
本次实现为 ObjectQL 添加了完整的文件上传、下载和管理功能。实现包括:
3+
Complete documentation for ObjectQL's file attachment implementation. This guide covers file storage abstraction, multipart form data parsing, validation, REST API endpoints, and comprehensive testing examples for building file upload functionality.
64

75
1. **文件存储抽象层** - 支持本地文件系统和内存存储,可扩展支持 S3、OSS 等云存储
86
2. **多部分表单数据解析** - 原生支持 multipart/form-data 文件上传

docs/examples/attachment-association-guide-cn.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# 附件如何与对象记录关联
1+
# Attachment Association Guide (Chinese)
22

3-
本文档详细说明在 ObjectQL 中如何将文件附件与对象记录关联,包括两种主要方案和最佳实践。
3+
Detailed guide on associating file attachments with object records in ObjectQL. This document covers two main approaches (embedded attachments vs. independent attachment objects), comparison, use cases, querying patterns, and best practices.
44

55
## 目录
66

docs/examples/file-upload-example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# File Upload Example
22

3-
This example demonstrates how to use the ObjectQL file upload API.
3+
Practical code example demonstrating how to use the ObjectQL file upload API. This example shows complete setup, initialization, and implementation of file upload functionality with ObjectQL server and local file storage.
44

55
## Setup
66

docs/examples/multiple-file-upload-guide-cn.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
1-
# 附件字段多选功能说明
1+
# Multiple File Upload Guide (Chinese)
22

3-
## 概述
4-
5-
ObjectQL 附件字段**完全支持多选功能**,允许在单个附件字段上传和存储多个文件。通过设置 `multiple: true` 属性即可启用。
3+
Complete guide for implementing multiple file upload functionality in ObjectQL attachment fields. Learn how to enable multi-select with `multiple: true`, configure validation, handle batch uploads, and implement image galleries.
64

75
## 字段定义
86

docs/examples/s3-integration-guide-cn.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# 如何使用 AWS S3 存储附件
1+
# AWS S3 Integration Guide (Chinese)
22

3-
本指南详细说明如何将 ObjectQL 文件附件存储到 AWS S3,包括完整的实现代码和最佳实践。
3+
Comprehensive guide for integrating AWS S3 storage with ObjectQL file attachments. This document covers architecture design, implementation, configuration, usage examples, advanced features, and best practices for scalable cloud storage.
44

55
## 目录
66

0 commit comments

Comments
 (0)