Skip to content

Commit 812b9f3

Browse files
Copilothuangyiirene
andcommitted
Rename to query best practices and remove Chinese version
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
1 parent 97e4fde commit 812b9f3

File tree

7 files changed

+10
-520
lines changed

7 files changed

+10
-520
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ ObjectQL supports three distinct query interfaces, each optimized for different
155155
* **REST API:** Simple CRUD operations, mobile apps, third-party integrations
156156
* **GraphQL:** Complex data graphs, modern SPAs, efficient multi-table fetching
157157

158-
**Not sure which to use?** Check out the [Query Syntax Alternatives & Optimization Guide](./docs/guide/query-syntax-alternatives.md) for detailed comparisons, performance strategies, and decision frameworks.
158+
**Looking for best practices?** Check out the [Query Best Practices Guide](./docs/guide/query-best-practices.md) for detailed comparisons, performance strategies, and optimization techniques.
159159

160160
---
161161

docs/.vitepress/config.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ const guideSidebar = [
2626
{ text: 'Data Modeling', link: '/guide/data-modeling' },
2727
{ text: 'Unified ID Migration', link: '/guide/migration-id-field' },
2828
{ text: 'Querying Data', link: '/guide/querying' },
29-
{ text: 'Query Syntax Alternatives', link: '/guide/query-syntax-alternatives' },
29+
{ text: 'Query Best Practices', link: '/guide/query-best-practices' },
3030
{ text: 'Formulas & Rules Syntax', link: '/guide/formulas-and-rules' },
3131
{ text: '↳ Quick Reference', link: '/guide/formulas-and-rules-quick-ref' },
3232
{ text: 'Business Logic (Hooks)', link: '/guide/logic-hooks' },

docs/api/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ ObjectQL uses a **unified `id` field** as the primary key across all database dr
2929
| **GraphQL** | Modern frontends with complex data requirements | `POST /api/graphql` | [Read Guide](./graphql.md) |
3030
| **Metadata** | Admin interfaces, schema discovery | `/api/metadata/*` | [Read Guide](./metadata.md) |
3131

32-
> **🚀 Choosing the right API style?**
33-
> Check out the [Query Syntax Alternatives & Optimization Guide](../guide/query-syntax-alternatives.md) for a detailed comparison, performance benchmarks, and decision frameworks to help you pick the best approach for your use case.
32+
> **🚀 Want to optimize your queries?**
33+
> Check out the [Query Best Practices Guide](../guide/query-best-practices.md) for performance optimization strategies, detailed comparisons, and recommendations to help you choose the best approach for your use case.
3434
3535
## Quick Links
3636

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Query Syntax Alternatives & Optimization Guide
1+
# Query Best Practices
22

3-
This guide evaluates the current ObjectQL query approaches and provides recommendations for different use cases, along with optimization strategies to maximize performance and developer experience.
3+
This guide provides best practices, performance optimization strategies, and recommendations for querying data in ObjectQL across different query interfaces (JSON-DSL, REST, GraphQL).
44

55
---
66

0 commit comments

Comments
 (0)