Skip to content

Self-hosted personal gallery application with online photo management and albums, supporting Live/Motion Photos, EXIF parsing, geolocation recognition, and an explore map.

docs: simplify page introductions and homepage copy

Timothy Yin18b1d169c43e
diff --git a/docs/.develop/queue-task-api.md b/docs/.develop/queue-task-api.md
index bb12d586..8532fa97 100644
--- a/docs/.develop/queue-task-api.md
+++ b/docs/.develop/queue-task-api.md
@@ -1,6 +1,6 @@
# 队列任务管理 API 文档
-本文档描述了ChronoFrame应用中新增的队列任务管理API端点。
+通过以下 API 查询任务状态、重试失败任务或清理任务记录。
## API 端点
diff --git a/docs/changelog.md b/docs/changelog.md
index 302b8ea8..69c65176 100644
--- a/docs/changelog.md
+++ b/docs/changelog.md
@@ -1,6 +1,6 @@
# Changelog
-Changes grouped by stable version. 1.0.0 includes all changes since v0.14.1, without separate beta or release-candidate entries. Historical entries are checked against adjacent stable Git tags; early prerelease tags are omitted.
+New features, improvements and fixes in each release.
## v1.0.0
diff --git a/docs/demo-sites.md b/docs/demo-sites.md
index 53de20ad..361ca2bb 100644
--- a/docs/demo-sites.md
+++ b/docs/demo-sites.md
@@ -1,6 +1,6 @@
# Demo Sites
-Explore galleries shared by ChronoFrame developers and community members. Select a card to visit a gallery.
+Photo galleries shared by ChronoFrame developers and community members. Select a card to visit the site.
## Developers
diff --git a/docs/development/api.md b/docs/development/api.md
index 8a9b5338..a50a0c23 100644
--- a/docs/development/api.md
+++ b/docs/development/api.md
@@ -3,7 +3,7 @@
The API uses the same session authentication as the web app. Authenticated requests carry the cookie obtained at sign-in; dashboard settings and management operations also check administrator privileges.
::: info API scope
-Common routes are listed below. For full parameters, responses and access rules, consult the routes and Zod validation in `server/api/`. These routes are not a versioned external API contract.
+Endpoints may change between releases. Check `server/api/` for request parameters, responses and permission checks before integrating.
:::
| Method | Path | Purpose |
diff --git a/docs/development/contributing.md b/docs/development/contributing.md
index 4a4085c9..cc532e87 100644
--- a/docs/development/contributing.md
+++ b/docs/development/contributing.md
@@ -1,6 +1,6 @@
# Contributing
-Use Node.js 22, matching the Docker build, and the project's pinned pnpm 10.34.6. This repository contains workspace packages; install dependencies with pnpm.
+Use Node.js 22 and pnpm 10.34.6. Install dependencies with pnpm to resolve the repository's workspace packages.
## Run locally
diff --git a/docs/development/how-to-add-setting.md b/docs/development/how-to-add-setting.md
index 457089ad..65a48121 100644
--- a/docs/development/how-to-add-setting.md
+++ b/docs/development/how-to-add-setting.md
@@ -1,6 +1,6 @@
# Adding a Setting
-Settings live in the database and are described by `DEFAULT_SETTINGS` in `server/services/settings/contants.ts`. Dashboard forms combine these definitions with UI configuration and translations.
+To add a dashboard setting, define its default value, configure its form field and add translations. Settings are saved in the database.
## Define the setting
diff --git a/docs/index.md b/docs/index.md
index df942f87..d912777c 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -5,7 +5,7 @@ layout: home
hero:
name: 'ChronoFrame'
text: 'Self-hosted Personal Gallery'
- tagline: 'Upload, organize and share your photos, with setup in your browser'
+ tagline: 'A home for your everyday moments and travels.'
image:
src: /logo.png
alt: ChronoFrame
@@ -22,24 +22,24 @@ hero:
link: /demo-sites
features:
- - title: Powerful Photo Management
+ - title: Photo Management
icon: 🖼️
- details: Easily manage and browse photos through web interface, view photo locations on map.
+ details: Upload in batches, edit photo details, and find photos with filters and sorting.
- title: Simple Deployment
icon: 🚀
- details: Start with Docker, then create your administrator and choose storage in the setup wizard. SQLite runs with the application.
- - title: Flexible Storage Solutions
+ details: Start with Docker and follow the setup wizard. No separate database installation is needed.
+ - title: Storage Options
icon: 💾
details: Use local files, S3-compatible storage or OpenList, with storage schemes managed in the dashboard.
- - title: Smart Geolocation
+ - title: Maps and Places
icon: 🌍
- details: Extract GPS and identify places through reverse geocoding, then browse them with MapLibre or Mapbox.
+ details: Identify shooting locations from photo GPS and revisit the places you have been on a map.
- title: Albums and Privacy
- icon: 📱
- details: Organize and reorder albums, hide them from public browsing or require a password.
- - title: Live/Motion Photo Support
+ icon: 🔒
+ details: Group photos into albums, arrange their order, and hide albums or protect them with a password.
+ - title: Live and Motion Photos
icon: 🎬
- details: Full support for Apple LivePhoto format and Google-standard Motion Photo, automatically detect and process MOV video files, preserve dynamic photo effects.
+ details: Play the motion captured in Apple Live Photos and Motion Photos while browsing your gallery.
---
## 🌍 Demo Sites
@@ -54,4 +54,4 @@ Browse galleries shared by developers and community members on the [Demo Sites p
## 📄 License
-ChronoFrame is open source under the [MIT License](https://github.com/HoshinoSuzumi/chronoframe/blob/main/LICENSE), welcome to use and contribute freely.
+ChronoFrame is released under the [MIT License](https://github.com/HoshinoSuzumi/chronoframe/blob/main/LICENSE).
diff --git a/docs/legacy/index.md b/docs/legacy/index.md
index fc5cd5d7..0c08eb0b 100644
--- a/docs/legacy/index.md
+++ b/docs/legacy/index.md
@@ -4,7 +4,7 @@ search: false
# Legacy
-These pages archive documentation for versions before v1.0.0. They can help with older installations and migration checks; their default accounts, environment variables and container commands may no longer apply.
+Documentation for versions before v1.0.0. The default accounts, environment variables and container commands on these pages may not apply to current versions.
- [Environment variables](/legacy/guide/configuration)
- [Storage](/legacy/configuration/storage-providers)
diff --git a/docs/zh/changelog.md b/docs/zh/changelog.md
index 5cde9eee..5bc59eb9 100644
--- a/docs/zh/changelog.md
+++ b/docs/zh/changelog.md
@@ -1,6 +1,6 @@
# 更新日志
-按正式版本汇总面向使用者的变更。1.0.0 收录 v0.14.1 之后的全部更新,不再逐个列出测试版。历史条目根据相邻正式版的 Git 标签核对;早期测试标签不单独列入。
+查看各版本的新功能、改进和问题修复。
## v1.0.0
diff --git a/docs/zh/demo-sites.md b/docs/zh/demo-sites.md
index 65844545..7659b0d1 100644
--- a/docs/zh/demo-sites.md
+++ b/docs/zh/demo-sites.md
@@ -1,6 +1,6 @@
# 演示站点
-看看开发者和社区用户如何用 ChronoFrame 展示自己的照片。点击卡片即可访问对应画廊。
+开发者和社区用户分享的 ChronoFrame 画廊。点击卡片访问站点。
## 开发者
diff --git a/docs/zh/development/api.md b/docs/zh/development/api.md
index e1fa43f6..58769f7b 100644
--- a/docs/zh/development/api.md
+++ b/docs/zh/development/api.md
@@ -3,7 +3,7 @@
API 与网页使用同一套会话认证。需要登录的请求携带登录后获得的 Cookie;后台设置和管理操作还会检查管理员权限。
::: info 接口范围
-下面列出常用入口,完整参数、响应和访问规则以 `server/api/` 的路由及其 Zod 校验为准。这不是一份固定版本的外部 API 合约。
+接口可能随版本调整。接入前请查看 `server/api/` 中对应路由的参数、响应和权限校验。
:::
| 方法 | 路径 | 用途 |
diff --git a/docs/zh/development/contributing.md b/docs/zh/development/contributing.md
index 30da892d..958e64a7 100644
--- a/docs/zh/development/contributing.md
+++ b/docs/zh/development/contributing.md
@@ -1,6 +1,6 @@
# 开始贡献
-使用 Node.js 22(与 Docker 构建环境一致)和项目指定的 pnpm 10.34.6。仓库包含 workspace 包,请使用 pnpm 安装依赖。
+准备 Node.js 22 和 pnpm 10.34.6。请使用 pnpm 安装依赖,以正确关联仓库内的 workspace 包。
## 本地运行
diff --git a/docs/zh/development/how-to-add-setting.md b/docs/zh/development/how-to-add-setting.md
index 0d28051a..1ba8ab91 100644
--- a/docs/zh/development/how-to-add-setting.md
+++ b/docs/zh/development/how-to-add-setting.md
@@ -1,6 +1,6 @@
# 如何添加一个新的设置项
-以在 `app` 命名空间中添加 `foo` 字段为例。
+新增后台设置需要定义默认值、配置表单字段并添加翻译。下面以 `app` 命名空间中的 `foo` 字段为例。
## 步骤 1:在 DEFAULT_SETTINGS 中添加字段定义
@@ -94,7 +94,7 @@ export const APP_SETTINGS_UI: Record<string, FieldUIConfig> = {
</template>
```
-✅ 完成!`foo` 字段会自动被 `useSettingsForm('app')` 获取并渲染。
+`useSettingsForm('app')` 会读取并渲染新增的 `foo` 字段。
## 条件字段示例
diff --git a/docs/zh/index.md b/docs/zh/index.md
index ff0a33e1..f19ccc94 100644
--- a/docs/zh/index.md
+++ b/docs/zh/index.md
@@ -5,7 +5,7 @@ layout: home
hero:
name: 'ChronoFrame'
text: '自部署个人画廊'
- tagline: '上传、整理和分享照片,在网页中完成站点设置'
+ tagline: '把日常与旅途,留在自己的相框中。'
image:
src: /logo.png
alt: ChronoFrame
@@ -22,24 +22,24 @@ hero:
link: /zh/demo-sites
features:
- - title: 强大的照片管理
+ - title: 照片管理
icon: 🖼️
- details: 通过网页界面轻松管理和浏览照片,并在地图上查看照片拍摄地点。
+ details: 批量上传、编辑照片信息,用筛选和排序找到想看的照片。
- title: 简单部署
icon: 🚀
- details: 使用 Docker 启动后,通过设置向导创建管理员和选择存储。SQLite 数据库随应用运行,无需单独部署。
- - title: 灵活的存储方案
+ details: 使用 Docker 启动,跟随向导完成设置,无需单独安装数据库。
+ - title: 多种存储
icon: 💾
details: 支持本地文件系统、S3 兼容存储和 OpenList,在后台管理存储方案。
- - title: 智能地理位置
+ - title: 地图与地点
icon: 🌍
- details: 提取照片 GPS,通过反向地理编码识别地点,使用 MapLibre 或 Mapbox 浏览地图。
+ details: 根据照片的 GPS 识别拍摄地点,在地图上回顾去过的地方。
- title: 相册与隐私
- icon: 📱
- details: 整理相册和照片顺序,设置隐藏相册或密码相册,控制画廊中的访问。
- - title: Live/Motion Photo 支持
+ icon: 🔒
+ details: 按主题整理相册、调整照片顺序,也可以隐藏相册或设置访问密码。
+ - title: 实况照片
icon: 🎬
- details: 完整支持 Apple LivePhoto 格式和 Google 标准的 Motion Photo,自动检测和处理 MOV 视频文件,保留动态照片效果。
+ details: 支持 Apple Live Photo 和 Motion Photo,在浏览照片时播放其中的动态片段。
---
## 🌍 演示站点
@@ -54,4 +54,4 @@ features:
## 📄 开源协议
-ChronoFrame 基于 [MIT 协议](https://github.com/HoshinoSuzumi/chronoframe/blob/main/LICENSE) 开源,欢迎自由使用和贡献。
+ChronoFrame 基于 [MIT 协议](https://github.com/HoshinoSuzumi/chronoframe/blob/main/LICENSE) 开源。
diff --git a/docs/zh/legacy/index.md b/docs/zh/legacy/index.md
index d68ce4a4..181bb459 100644
--- a/docs/zh/legacy/index.md
+++ b/docs/zh/legacy/index.md
@@ -4,7 +4,7 @@ search: false
# Legacy
-这里归档 v1.0.0 之前的版本文档,便于维护旧实例和核对迁移前的配置。示例中的默认账号、环境变量、容器命令可能已不适用于当前版本。
+这里归档 v1.0.0 之前的版本文档。文中的默认账号、环境变量和容器命令可能已不适用于当前版本。
- [环境变量](/zh/legacy/guide/configuration)
- [存储提供器](/zh/legacy/configuration/storage-providers)