Skip to content

Commit 529cd66

Browse files
committed
docs: rename quick start entry pages
1 parent 9bcf3b0 commit 529cd66

16 files changed

Lines changed: 48 additions & 48 deletions

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Database-native production data runtime layer for TypeScript services. monSQLize
88
[![Node.js](https://img.shields.io/badge/Node.js-18%2B-brightgreen)](https://nodejs.org/)
99

1010
Documentation: [English](https://vextjs.github.io/monSQLize/) · [简体中文](https://vextjs.github.io/monSQLize/zh/)
11-
Quick path: [Getting Started](https://vextjs.github.io/monSQLize/getting-started) · [Basic Operations](https://vextjs.github.io/monSQLize/basic-operations)
11+
Quick path: [Installation](https://vextjs.github.io/monSQLize/getting-started) · [Basic Usage](https://vextjs.github.io/monSQLize/basic-operations)
1212
Configuration reference: [English](https://vextjs.github.io/monSQLize/configuration) · [简体中文](https://vextjs.github.io/monSQLize/zh/configuration)
1313

1414
```bash
@@ -129,7 +129,7 @@ await users.updateOne(
129129
await msq.close();
130130
```
131131

132-
Next, use the [Basic Operations guide](https://vextjs.github.io/monSQLize/basic-operations) for common CRUD, pagination, read cache, and Model entry-point examples.
132+
Next, use the [Basic Usage guide](https://vextjs.github.io/monSQLize/basic-operations) for common CRUD, pagination, read cache, and Model entry-point examples.
133133

134134
### ESM and TypeScript
135135

docs/en/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ This documentation starts with the common application path: connect to MongoDB,
66

77
| Goal | Start here | Notes |
88
|------|------------|-------|
9-
| Install, connect, and run the first query | [`getting-started.md`](./getting-started.md) | Shortest path for a MongoDB-backed collection |
10-
| Run common collection operations | [`basic-operations.md`](./basic-operations.md) | Daily CRUD, pagination, cache TTL, and Model entry-point guidance |
9+
| Install, connect, and run the first query | [`getting-started.md`](./getting-started.md) | Installation and minimal connection validation |
10+
| Learn basic usage for common collection operations | [`basic-operations.md`](./basic-operations.md) | Daily CRUD, pagination, cache TTL, and Model entry-point guidance |
1111
| Configure `new MonSQLize(options)` | [`configuration.md`](./configuration.md) | Complete constructor options, defaults, cache, Redis, Model, sync, pools, and logging |
1212
| Match docs to runnable source | [`examples.md`](./examples.md) | Links each topic to a GitHub example source |
1313
| Add database caching | [`cache.md`](./cache.md) | Collection query cache, Redis L2 cache, and distributed invalidation |
@@ -19,8 +19,8 @@ This documentation starts with the common application path: connect to MongoDB,
1919
## Recommended Reading Order
2020

2121
1. Package entry: [repository README](../../README.md)
22-
2. Quick start: [`getting-started.md`](./getting-started.md)
23-
3. Basic operations: [`basic-operations.md`](./basic-operations.md)
22+
2. Installation: [`getting-started.md`](./getting-started.md)
23+
3. Basic usage: [`basic-operations.md`](./basic-operations.md)
2424
4. Constructor configuration: [`configuration.md`](./configuration.md)
2525
5. Examples:
2626
- [examples/README.md](https://github.com/vextjs/monSQLize/blob/main/examples/README.md)

docs/en/api-index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This index documents the current stable MongoDB adapter APIs and shared runtime
77
| Document | Description |
88
|----------|-------------|
99
| [Native API comparison](mongodb-native-vs-extensions.md) | **MongoDB native APIs vs monSQLize extensions** |
10-
| [Basic operations](basic-operations.md) | Common CRUD, pagination, read cache, and Model entry-point examples |
10+
| [Basic usage](basic-operations.md) | Common CRUD, pagination, read cache, and Model entry-point examples |
1111
| [Configuration reference](configuration.md) | Complete `new MonSQLize(options)` constructor options |
1212
| [Connection management](connection.md) | Connection lifecycle and accessors |
1313
| [Pool configuration](multi-pool.md) | Multi-pool configuration and runtime routing: declare `pools: PoolConfig[]` in the constructor and access pools through `pool()` / `use()` |
@@ -184,8 +184,8 @@ This index documents the current stable MongoDB adapter APIs and shared runtime
184184
| [Documentation index](README.md) | Documentation directory index |
185185
| [Site home](index.md) | Documentation site home |
186186
| [API reference index](api-index.md) | Current API reference index |
187-
| [Getting started](getting-started.md) | Getting started guide |
188-
| [Basic operations](basic-operations.md) | Common operations after the first connection succeeds |
187+
| [Installation](getting-started.md) | Installation and minimal connection validation |
188+
| [Basic usage](basic-operations.md) | Common operations after the first connection succeeds |
189189
| [Examples](examples.md) | Example index |
190190
| [Common scenarios](recipes.md) | Connection, cache, Redis, SSH, pool, and Model usage scenarios |
191191
| [Capability index](capability-index.md) | Capability index |
@@ -236,12 +236,12 @@ This index documents the current stable MongoDB adapter APIs and shared runtime
236236

237237
---
238238

239-
## Quick Start Path
239+
## Start Path
240240

241241
Recommended reading order for new users:
242242

243-
1. [Getting started](getting-started.md) - Install, connect, and run the first query.
244-
2. [Basic operations](basic-operations.md) - Run common CRUD, pagination, cache, and Model entry-point examples.
243+
1. [Installation](getting-started.md) - Install, connect, and run the first query.
244+
2. [Basic usage](basic-operations.md) - Run common CRUD, pagination, cache, and Model entry-point examples.
245245
3. [Configuration reference](configuration.md) - Choose constructor options for the service.
246246
4. [Connection management](connection.md) - Learn connection lifecycle and accessors.
247247
5. [Find documents](find.md) - Learn query details.

docs/en/basic-operations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Basic Operations
1+
# Basic Usage
22

33
## What This Page Covers
44

5-
Use this page after [Getting Started](./getting-started.md). It shows the daily collection operations most applications need before you open the full API reference:
5+
After installation and the first connection, use this page to run the common data flow most applications need. The examples follow the usual development order: write and query data first, then paginate, update, cache reads, and decide when to switch to `model()`:
66

77
- Insert one or many documents
88
- Query one document or a list

docs/en/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -510,7 +510,7 @@ await users.find({}); // Uses 3000.
510510

511511
## Related pages
512512

513-
- [Getting Started](./getting-started.md)
513+
- [Installation](./getting-started.md)
514514
- [Connection Management](./connection.md)
515515
- [Cache API](./cache.md)
516516
- [Pool Configuration](./multi-pool.md)

docs/en/examples.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ tsc -p tsconfig.examples.json
2020
node .generated/examples-dist/examples/docs/find.js
2121
```
2222

23-
## Quick Start
23+
## Intro Examples
2424

2525
| Document | Example |
2626
|----------|---------|

docs/en/getting-started.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
1-
# Getting Started
1+
# Installation
22

33
## What This Page Covers
44

5-
This page covers the shortest path from installation to a working MongoDB-backed collection:
5+
This page covers the path from installing monSQLize to validating a minimal MongoDB-backed collection:
66

77
- Installation
88
- Initializing `MonSQLize`
99
- `connect()`
1010
- `collection()`
1111
- Basic writes and queries
1212
- Closing the connection
13-
- Where to continue with common operations
13+
- Where to continue with basic usage
1414

1515
## Installation
1616

@@ -69,7 +69,7 @@ The current official example is [`examples/quick-start/basic-connect.ts`](https:
6969

7070
## Next Steps
7171

72-
- Continue with daily CRUD, pagination, cache, and Model entry points in [`basic-operations.md`](./basic-operations.md).
72+
- Continue with common CRUD, pagination, cache, and Model entry points in [`basic-operations.md`](./basic-operations.md).
7373
- Review all constructor options in [`configuration.md`](./configuration.md).
7474
- Learn query details in [`find.md`](./find.md), [`findOne.md`](./findOne.md), and [`findPage.md`](./findPage.md).
7575
- Compare runnable examples in [`examples.md`](./examples.md).

docs/en/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ hero:
1111
alt: monSQLize hero mark
1212
actions:
1313
- theme: brand
14-
text: Quick Start
14+
text: Installation
1515
link: /getting-started.html
1616
- theme: alt
17-
text: Basic Operations
17+
text: Basic Usage
1818
link: /basic-operations.html
1919
- theme: alt
2020
text: Configuration

docs/zh/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66

77
| 目标 | 入口 | 说明 |
88
|------|------|------|
9-
| 安装、连接、完成第一次查询 | [`getting-started.md`](./getting-started.md) | MongoDB 集合最短上手路径 |
10-
| 完成常用集合操作 | [`basic-operations.md`](./basic-operations.md) | 日常 CRUD、分页、缓存 TTL 与 Model 入口选择 |
9+
| 安装、连接、完成第一次查询 | [`getting-started.md`](./getting-started.md) | 安装与最小连接验证 |
10+
| 快速上手常用集合操作 | [`basic-operations.md`](./basic-operations.md) | 日常 CRUD、分页、缓存 TTL 与 Model 入口选择 |
1111
| 配置 `new MonSQLize(options)` | [`configuration.md`](./configuration.md) | 构造函数完整参数、默认值、缓存、Redis、Model、同步、连接池与日志 |
1212
| 对照文档与可运行源码 | [`examples.md`](./examples.md) | 每个主题都链接到 GitHub 示例源码 |
1313
| 添加数据库缓存 | [`cache.md`](./cache.md) | 集合查询缓存、Redis 二级缓存、分布式失效 |
@@ -19,8 +19,8 @@
1919
## 推荐阅读顺序
2020

2121
1. 根入口说明:[仓库 README](../../README.md)
22-
2. 上手路径[`getting-started.md`](./getting-started.md)
23-
3. 基础常用操作[`basic-operations.md`](./basic-operations.md)
22+
2. 安装[`getting-started.md`](./getting-started.md)
23+
3. 快速上手[`basic-operations.md`](./basic-operations.md)
2424
4. 构造配置:[`configuration.md`](./configuration.md)
2525
5. 可执行示例:
2626
- [examples/README.md](https://github.com/vextjs/monSQLize/blob/main/examples/README.md)

docs/zh/api-index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
| 文档 | 说明 |
88
|------|------|
99
| [原生 API 对比](mongodb-native-vs-extensions.md) | **MongoDB 原生 vs monSQLize 扩展功能对比** |
10-
| [基础常用操作](basic-operations.md) | 常用 CRUD、分页、读缓存与 Model 入口示例 |
10+
| [快速上手](basic-operations.md) | 常用 CRUD、分页、读缓存与 Model 入口示例 |
1111
| [完整配置参考](configuration.md) | `new MonSQLize(options)` 构造函数完整参数 |
1212
| [连接管理](connection.md) | 连接生命周期与访问器 |
1313
| [连接池配置](multi-pool.md) | 多连接池配置与运行时路由:在构造函数中声明 `pools: PoolConfig[]`,通过 `pool()` / `use()` 访问 |
@@ -182,8 +182,8 @@
182182
| [文档目录索引](README.md) | docs 目录索引 |
183183
| [文档站首页](index.md) | 文档站首页 |
184184
| [API 参考索引](api-index.md) | 当前 API 参考索引 |
185-
| [入门指南](getting-started.md) | 入门指南 |
186-
| [基础常用操作](basic-operations.md) | 第一次连接成功后的常用操作 |
185+
| [安装](getting-started.md) | 安装与最小连接验证 |
186+
| [快速上手](basic-operations.md) | 第一次连接成功后的常用操作 |
187187
| [示例索引](examples.md) | 示例索引 |
188188
| [场景指南](recipes.md) | 连接、缓存、Redis、SSH、连接池与 Model 的场景指南 |
189189
| [能力索引](capability-index.md) | 能力索引 |
@@ -234,12 +234,12 @@
234234

235235
---
236236

237-
## 快速开始路径
237+
## 入门路径
238238

239239
**新用户推荐阅读顺序**:
240240

241-
1. [快速开始](getting-started.md) - 安装、连接并完成第一次查询
242-
2. [基础常用操作](basic-operations.md) - 完成常用 CRUD、分页、缓存和 Model 入口示例
241+
1. [安装](getting-started.md) - 安装、连接并完成第一次查询
242+
2. [快速上手](basic-operations.md) - 完成常用 CRUD、分页、缓存和 Model 入口示例
243243
3. [完整配置参考](configuration.md) - 选择服务需要的构造参数
244244
4. [连接管理](connection.md) - 了解连接生命周期与访问器
245245
5. [查询多个文档](find.md) - 学习查询细节

0 commit comments

Comments
 (0)