From 9060f747b55439f4a346fca08b84eaa57f1acc47 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 23 Jan 2026 01:07:28 +0000 Subject: [PATCH 01/11] Initial plan From 5043ae71bf51c3001f545a9e332aa16466790d8c Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 23 Jan 2026 01:11:55 +0000 Subject: [PATCH 02/11] Fix all fumadocs link errors - convert to relative links Co-authored-by: xuyushun441-sys <255036401+xuyushun441-sys@users.noreply.github.com> --- content/docs/faq.mdx | 4 +- content/docs/guides/field-types.cn.mdx | 12 +++--- content/docs/guides/field-types.mdx | 12 +++--- content/docs/guides/getting-started.cn.mdx | 10 ++--- content/docs/guides/getting-started.mdx | 10 ++--- content/docs/guides/migration/index.mdx | 2 +- content/docs/guides/view-configuration.mdx | 8 ++-- content/docs/guides/workflows-validation.mdx | 8 ++-- content/docs/index.cn.mdx | 26 ++++++------ content/docs/index.mdx | 34 +++++++-------- content/docs/quick-start.mdx | 14 +++---- content/docs/quick-start/architects.mdx | 8 ++-- .../docs/quick-start/backend-developers.mdx | 16 +++---- content/docs/quick-start/build-first-app.mdx | 6 +-- .../docs/quick-start/frontend-developers.mdx | 8 ++-- .../specifications/architecture/index.mdx | 6 +-- content/docs/specifications/data/index.mdx | 40 +++++++++--------- content/docs/specifications/index.mdx | 30 ++++++------- content/docs/specifications/server/index.mdx | 42 +++++++++---------- .../specifications/server/rest-api.cn.mdx | 2 +- .../docs/specifications/server/rest-api.mdx | 2 +- content/docs/specifications/ui/index.mdx | 38 ++++++++--------- content/docs/standards/index.mdx | 8 ++-- content/docs/troubleshooting.mdx | 2 +- content/docs/tutorials.mdx | 38 ++++++++--------- 25 files changed, 193 insertions(+), 193 deletions(-) diff --git a/content/docs/faq.mdx b/content/docs/faq.mdx index 77ff46f..3f5d6cd 100644 --- a/content/docs/faq.mdx +++ b/content/docs/faq.mdx @@ -169,7 +169,7 @@ ObjectStack apps are standard Node.js applications. Deploy like any Node app: - **Serverless:** AWS Lambda, Google Cloud Functions - **PaaS:** Heroku, Railway, Render -See the [Deployment Guide](/docs/guides/deployment) for details. +See the [Deployment Guide](./guides/deployment) for details. ## Development Questions @@ -306,7 +306,7 @@ Field.lookup({ ## Still Have Questions? -- 📖 Check the [Guides](/docs/guides/getting-started) +- 📖 Check the [Guides](./guides/getting-started) - 💬 Ask in [GitHub Discussions](https://github.com/objectstack-ai/spec/discussions) - 🐛 Report bugs in [GitHub Issues](https://github.com/objectstack-ai/spec/issues) - 📧 Email: support@objectstack.dev (for urgent issues) diff --git a/content/docs/guides/field-types.cn.mdx b/content/docs/guides/field-types.cn.mdx index d149ad6..94e9ab4 100644 --- a/content/docs/guides/field-types.cn.mdx +++ b/content/docs/guides/field-types.cn.mdx @@ -451,7 +451,7 @@ days_open: Field.formula({ ``` > ℹ️ **Info:** - 公式字段自动计算且只读。可用函数请参见 [公式函数](/docs/references/data/formulas)。 + 公式字段自动计算且只读。可用函数请参见 [公式函数](../references/data/formulas)。 --- @@ -737,7 +737,7 @@ created_at: Field.datetime({ ## CRM 示例 -参见 **[CRM 示例](/examples/crm)** 了解所有字段类型的实际使用： +参见 **[CRM 示例](https://github.com/objectstack-ai/spec/tree/main/examples/crm)** 了解所有字段类型的实际使用： - **账户：** 自动编号、公式、货币、带颜色的选择 - **联系人：** 主从关系、公式（全名）、头像、电子邮件、电话 @@ -749,7 +749,7 @@ created_at: Field.datetime({ ## 下一步 -- [对象架构指南](/docs/guides/object-schema) -- [验证规则](/docs/guides/validation-rules) -- [工作流自动化](/docs/guides/workflows) -- [字段 API 参考](/docs/references/data/core/Field) +- [对象架构指南](../guides/object-schema) +- [验证规则](../guides/validation-rules) +- [工作流自动化](../guides/workflows) +- [字段 API 参考](../references/data/core/Field) diff --git a/content/docs/guides/field-types.mdx b/content/docs/guides/field-types.mdx index b088c75..9ff345b 100644 --- a/content/docs/guides/field-types.mdx +++ b/content/docs/guides/field-types.mdx @@ -451,7 +451,7 @@ days_open: Field.formula({ ``` > ℹ️ **Info:** - Formula fields are automatically calculated and readonly. See [Formula Functions](/docs/references/data/formulas) for available functions. + Formula fields are automatically calculated and readonly. See [Formula Functions](../references/data/formulas) for available functions. --- @@ -737,7 +737,7 @@ created_at: Field.datetime({ ## Examples from CRM -See the **[CRM Example](/examples/crm)** for real-world usage of all field types: +See the **[CRM Example](https://github.com/objectstack-ai/spec/tree/main/examples/crm)** for real-world usage of all field types: - **Account:** Autonumber, formula, currency, select with colors - **Contact:** Master-detail, formula (full_name), avatar, email, phone @@ -749,7 +749,7 @@ See the **[CRM Example](/examples/crm)** for real-world usage of all field types ## Next Steps -- [Object Schema Guide](/docs/guides/object-schema) -- [Validation Rules](/docs/guides/validation-rules) -- [Workflow Automation](/docs/guides/workflows) -- [Field API Reference](/docs/references/data/core/Field) +- [Object Schema Guide](../guides/object-schema) +- [Validation Rules](../guides/validation-rules) +- [Workflow Automation](../guides/workflows) +- [Field API Reference](../references/data/core/Field) diff --git a/content/docs/guides/getting-started.cn.mdx b/content/docs/guides/getting-started.cn.mdx index fface86..24ac970 100644 --- a/content/docs/guides/getting-started.cn.mdx +++ b/content/docs/guides/getting-started.cn.mdx @@ -275,15 +275,15 @@ views: { 现在你有了有效的元数据，你可以： -1. **探索示例**：查看 [CRM 示例](/examples/crm) 了解完整功能实现 -2. **学习字段类型**：参见 [字段类型指南](/docs/guides/field-types) 了解所有 30+ 种字段类型 +1. **探索示例**：查看 [CRM 示例](https://github.com/objectstack-ai/spec/tree/main/examples/crm) 了解完整功能实现 +2. **学习字段类型**：参见 [字段类型指南](../guides/field-types) 了解所有 30+ 种字段类型 3. **构建 UI**：使用 ObjectStack 运行时的元数据来生成界面 4. **部署**：推送到 ObjectStack 内核用于生产环境 **其他资源：** -- [对象模式参考](/docs/references/data/core/Object) -- [验证规则](/docs/guides/validation-rules) -- [工作流自动化](/docs/guides/workflows) +- [对象模式参考](../references/data/core/Object) +- [验证规则](../guides/validation-rules) +- [工作流自动化](../guides/workflows) diff --git a/content/docs/guides/getting-started.mdx b/content/docs/guides/getting-started.mdx index 21654c3..ee11ffd 100644 --- a/content/docs/guides/getting-started.mdx +++ b/content/docs/guides/getting-started.mdx @@ -275,15 +275,15 @@ views: { Now that you have valid metadata, you can: -1. **Explore Examples**: Check out the [CRM Example](/examples/crm) for a full-featured implementation -2. **Learn Field Types**: See the [Field Types Guide](/docs/guides/field-types) for all 30+ field types +1. **Explore Examples**: Check out the [CRM Example](https://github.com/objectstack-ai/spec/tree/main/examples/crm) for a full-featured implementation +2. **Learn Field Types**: See the [Field Types Guide](../guides/field-types) for all 30+ field types 3. **Build UI**: Use the metadata with ObjectStack runtime to generate interfaces 4. **Deploy**: Push to an ObjectStack kernel for production use **Additional Resources:** -- [Object Schema Reference](/docs/references/data/core/Object) -- [Validation Rules](/docs/guides/validation-rules) -- [Workflow Automation](/docs/guides/workflows) +- [Object Schema Reference](../references/data/core/Object) +- [Validation Rules](../guides/validation-rules) +- [Workflow Automation](../guides/workflows) diff --git a/content/docs/guides/migration/index.mdx b/content/docs/guides/migration/index.mdx index 3b0ec01..8945c85 100644 --- a/content/docs/guides/migration/index.mdx +++ b/content/docs/guides/migration/index.mdx @@ -9,7 +9,7 @@ This section contains guides for migrating your applications between different v ## Available Guides -### [Version 0.x to 1.x Migration](/docs/guides/migration/v0-to-v1) +### [Version 0.x to 1.x Migration](../../guides/migration/v0-to-v1) Complete guide for migrating from version 0.x to 1.x, including: - Breaking changes - New features diff --git a/content/docs/guides/view-configuration.mdx b/content/docs/guides/view-configuration.mdx index b8fd77b..089a09d 100644 --- a/content/docs/guides/view-configuration.mdx +++ b/content/docs/guides/view-configuration.mdx @@ -800,7 +800,7 @@ export const Opportunity = ObjectSchema.create({ ## Next Steps -- [Field Types Guide](/docs/guides/field-types) -- [Workflows & Validation](/docs/guides/workflows-validation) -- [Dashboard Configuration](/docs/guides/dashboards) -- [CRM Example](/examples/crm) - See all view types in action +- [Field Types Guide](../guides/field-types) +- [Workflows & Validation](../guides/workflows-validation) +- [Dashboard Configuration](../guides/dashboards) +- [CRM Example](https://github.com/objectstack-ai/spec/tree/main/examples/crm) - See all view types in action diff --git a/content/docs/guides/workflows-validation.mdx b/content/docs/guides/workflows-validation.mdx index 9872f2c..cd19084 100644 --- a/content/docs/guides/workflows-validation.mdx +++ b/content/docs/guides/workflows-validation.mdx @@ -727,7 +727,7 @@ export const Opportunity = ObjectSchema.create({ ## Next Steps -- [Field Types Guide](/docs/guides/field-types) -- [Object Schema Reference](/docs/references/data/core/Object) -- [Formula Functions](/docs/references/data/formulas) -- [CRM Example](/examples/crm) - See validations and workflows in action +- [Field Types Guide](../guides/field-types) +- [Object Schema Reference](../references/data/core/Object) +- [Formula Functions](../references/data/formulas) +- [CRM Example](https://github.com/objectstack-ai/spec/tree/main/examples/crm) - See validations and workflows in action diff --git a/content/docs/index.cn.mdx b/content/docs/index.cn.mdx index e2e3fbd..ccc5ce1 100644 --- a/content/docs/index.cn.mdx +++ b/content/docs/index.cn.mdx @@ -16,25 +16,25 @@ import { Book, Compass, FileText, Layers } from 'lucide-react'; } title="快速开始" - href="/docs/guides/getting-started" + href="./guides/getting-started" description="5 分钟内构建你的第一个对象。通过实际示例学习基础知识。" /> } title="概念" - href="/docs/concepts/manifesto" + href="./concepts/manifesto" description="理解「意图优于实现」和「本地优先」架构的理念。" /> } title="规范" - href="/docs/specifications/data/architecture" + href="./specifications/data/architecture" description="架构蓝图。深入了解 ObjectQL（数据）、ObjectUI（视图）和 ObjectOS（控制）。" /> } title="协议参考" - href="/docs/references/data/core/Object" + href="./references/data/core/Object" description="字典。每个模式、字段类型和配置选项的全面参考。" /> @@ -42,14 +42,14 @@ import { Book, Compass, FileText, Layers } from 'lucide-react'; ## 快速链接 ### 基础指南 -- **[字段类型](/docs/guides/field-types)** - 30+ 种字段类型及示例（文本、数字、选择、查找、公式等） -- **[视图配置](/docs/guides/view-configuration)** - 网格、看板、日历、甘特图和表单布局 -- **[工作流与验证](/docs/guides/workflows-validation)** - 业务规则和自动化 -- **[项目结构](/docs/guides/project-structure)** - 组织代码的最佳实践 +- **[字段类型](./guides/field-types)** - 30+ 种字段类型及示例（文本、数字、选择、查找、公式等） +- **[视图配置](./guides/view-configuration)** - 网格、看板、日历、甘特图和表单布局 +- **[工作流与验证](./guides/workflows-validation)** - 业务规则和自动化 +- **[项目结构](./guides/project-structure)** - 组织代码的最佳实践 ### 示例 -- **[CRM 示例](/examples/crm)** - 全功能应用，包含 6 个对象、工作流、视图、仪表板 -- **[Todo 示例](/examples/todo)** - 快速入门最小化示例 +- **[CRM 示例](https://github.com/objectstack-ai/spec/tree/main/examples/crm)** - 全功能应用，包含 6 个对象、工作流、视图、仪表板 +- **[Todo 示例](https://github.com/objectstack-ai/spec/tree/main/examples/todo)** - 快速入门最小化示例 ## "五位一体"架构 @@ -57,9 +57,9 @@ ObjectStack 建立在五个协同工作的核心模块之上： | 模块 | 协议 | 职责 | | :--- | :--- | :--- | -| **数据层** | **[ObjectQL](/docs/specifications/data/architecture)** | 定义数据的形状（`Object`、`Field`）以及如何访问它（`Query AST`）。与 SQL/NoSQL 无关。 | -| **UI 层** | **[ObjectUI](/docs/specifications/ui/sdui-protocol)** | 投影层。将用户界面定义为抽象的 JSON 布局（视图、仪表板、操作）。 | -| **控制层** | **[ObjectOS](/docs/specifications/server/kernel-architecture)** | 内核。处理身份、安全、同步和自动化。 | +| **数据层** | **[ObjectQL](./specifications/data/architecture)** | 定义数据的形状（`Object`、`Field`）以及如何访问它（`Query AST`）。与 SQL/NoSQL 无关。 | +| **UI 层** | **[ObjectUI](./specifications/ui/sdui-protocol)** | 投影层。将用户界面定义为抽象的 JSON 布局（视图、仪表板、操作）。 | +| **控制层** | **[ObjectOS](./specifications/server/kernel-architecture)** | 内核。处理身份、安全、同步和自动化。 | | **AI 层** | **AI 协议** | AI 代理定义、工具、知识库和模型配置。 | | **API 层** | **API 协议** | 标准化的 REST/GraphQL 契约，带请求/响应封装。 | diff --git a/content/docs/index.mdx b/content/docs/index.mdx index 360d498..b542800 100644 --- a/content/docs/index.mdx +++ b/content/docs/index.mdx @@ -16,25 +16,25 @@ This documentation is the authoritative reference for the ObjectStack Protocol. } title="Quick Start" - href="/docs/quick-start" + href="./quick-start" description="Get started in under 5 minutes. Choose your learning path based on your role." /> } title="Tutorials" - href="/docs/tutorials" + href="./tutorials" description="Hands-on step-by-step tutorials to build real applications and learn by doing." /> } title="Concepts" - href="/docs/concepts/manifesto" + href="./concepts/manifesto" description="Understand the philosophy of 'Intent over Implementation' and the 'Local-First' architecture." /> } title="Specifications" - href="/docs/specifications" + href="./specifications" description="The Architecture Blueprints. Deep dive into ObjectQL (Data), ObjectUI (View), and ObjectOS (Control)." /> @@ -45,25 +45,25 @@ This documentation is the authoritative reference for the ObjectStack Protocol. } title="Developer Guides" - href="/docs/guides/getting-started" + href="./guides/getting-started" description="Comprehensive guides for building with ObjectStack. Field types, views, workflows, and more." /> } title="API Reference" - href="/docs/references/data/core/Object" + href="./references/data/core/Object" description="Complete API documentation for every schema, field type, and configuration option." /> } title="FAQ" - href="/docs/faq" + href="./faq" description="Frequently asked questions about ObjectStack and how to use it." /> } title="Troubleshooting" - href="/docs/troubleshooting" + href="./troubleshooting" description="Common issues and how to resolve them." /> @@ -71,14 +71,14 @@ This documentation is the authoritative reference for the ObjectStack Protocol. ## Quick Links ### Essential Guides -- **[Field Types](/docs/guides/field-types)** - 30+ field types with examples (text, number, select, lookup, formula, etc.) -- **[View Configuration](/docs/guides/view-configuration)** - Grid, Kanban, Calendar, Gantt, and Form layouts -- **[Workflows & Validation](/docs/guides/workflows-validation)** - Business rules and automation -- **[Project Structure](/docs/guides/project-structure)** - Best practices for organizing your code +- **[Field Types](./guides/field-types)** - 30+ field types with examples (text, number, select, lookup, formula, etc.) +- **[View Configuration](./guides/view-configuration)** - Grid, Kanban, Calendar, Gantt, and Form layouts +- **[Workflows & Validation](./guides/workflows-validation)** - Business rules and automation +- **[Project Structure](./guides/project-structure)** - Best practices for organizing your code ### Examples -- **[CRM Example](/examples/crm)** - Full-featured application with 6 objects, workflows, views, dashboards -- **[Todo Example](/examples/todo)** - Quick-start minimal example +- **[CRM Example](https://github.com/objectstack-ai/spec/tree/main/examples/crm)** - Full-featured application with 6 objects, workflows, views, dashboards +- **[Todo Example](https://github.com/objectstack-ai/spec/tree/main/examples/todo)** - Quick-start minimal example ## The "Trinity" Architecture @@ -86,9 +86,9 @@ ObjectStack is built on five core modules that work in unison: | Module | Protocol | Responsibility | | :--- | :--- | :--- | -| **Data Layer** | **[ObjectQL](/docs/specifications/data/architecture)** | Defines the shape of data (`Object`, `Field`) and how to access it (`Query AST`). Agnostic to SQL/NoSQL. | -| **UI Layer** | **[ObjectUI](/docs/specifications/ui/sdui-protocol)** | The Projection. Defines User Interfaces as abstract JSON layouts (Views, Dashboards, Actions). | -| **Control Layer** | **[ObjectOS](/docs/specifications/server/kernel-architecture)** | The Kernel. Handles Identity, Security, Sync, and Automation. | +| **Data Layer** | **[ObjectQL](./specifications/data/architecture)** | Defines the shape of data (`Object`, `Field`) and how to access it (`Query AST`). Agnostic to SQL/NoSQL. | +| **UI Layer** | **[ObjectUI](./specifications/ui/sdui-protocol)** | The Projection. Defines User Interfaces as abstract JSON layouts (Views, Dashboards, Actions). | +| **Control Layer** | **[ObjectOS](./specifications/server/kernel-architecture)** | The Kernel. Handles Identity, Security, Sync, and Automation. | | **AI Layer** | **AI Protocol** | AI agent definitions, tools, knowledge bases, and model configurations. | | **API Layer** | **API Protocol** | Standardized REST/GraphQL contracts with request/response envelopes. | diff --git a/content/docs/quick-start.mdx b/content/docs/quick-start.mdx index 162419f..8763499 100644 --- a/content/docs/quick-start.mdx +++ b/content/docs/quick-start.mdx @@ -13,25 +13,25 @@ Welcome to ObjectStack! This quick start guide will help you get up and running } title="I want to build an app" - href="/docs/quick-start/build-first-app" + href="./quick-start/build-first-app" description="Complete tutorial: Build a task management app in 10 minutes" /> } title="I'm a backend developer" - href="/docs/quick-start/backend-developers" + href="./quick-start/backend-developers" description="Learn how to define Objects, Fields, and Business Logic" /> } title="I'm a frontend developer" - href="/docs/quick-start/frontend-developers" + href="./quick-start/frontend-developers" description="Understand Views, Pages, and UI Components" /> } title="I'm a platform architect" - href="/docs/quick-start/architects" + href="./quick-start/architects" description="Deep dive into the protocol architecture and design decisions" /> @@ -85,9 +85,9 @@ npm install @objectstack/spec zod ### 2. Choose your learning path -- **Quick & Practical:** [Build Your First App](/docs/quick-start/build-first-app) - Hands-on tutorial -- **Conceptual Understanding:** [Core Concepts](/docs/concepts/manifesto) - Philosophy and architecture -- **Complete Reference:** [Developer Guides](/docs/guides/getting-started) - Comprehensive documentation +- **Quick & Practical:** [Build Your First App](./quick-start/build-first-app) - Hands-on tutorial +- **Conceptual Understanding:** [Core Concepts](./concepts/manifesto) - Philosophy and architecture +- **Complete Reference:** [Developer Guides](./guides/getting-started) - Comprehensive documentation ### 3. Explore examples diff --git a/content/docs/quick-start/architects.mdx b/content/docs/quick-start/architects.mdx index 87ad624..8d2715f 100644 --- a/content/docs/quick-start/architects.mdx +++ b/content/docs/quick-start/architects.mdx @@ -475,22 +475,22 @@ app.get('/legacy', legacyController); diff --git a/content/docs/quick-start/backend-developers.mdx b/content/docs/quick-start/backend-developers.mdx index 5c907d5..2e88708 100644 --- a/content/docs/quick-start/backend-developers.mdx +++ b/content/docs/quick-start/backend-developers.mdx @@ -366,22 +366,22 @@ describe('Task Object', () => { @@ -390,7 +390,7 @@ describe('Task Object', () => { Coming from another framework? We've got you covered: -- [Prisma → ObjectStack](/docs/guides/migration/prisma) -- [TypeORM → ObjectStack](/docs/guides/migration/typeorm) -- [Sequelize → ObjectStack](/docs/guides/migration/sequelize) -- [Mongoose → ObjectStack](/docs/guides/migration/mongoose) +- [Prisma → ObjectStack](../guides/migration/prisma) +- [TypeORM → ObjectStack](../guides/migration/typeorm) +- [Sequelize → ObjectStack](../guides/migration/sequelize) +- [Mongoose → ObjectStack](../guides/migration/mongoose) diff --git a/content/docs/quick-start/build-first-app.mdx b/content/docs/quick-start/build-first-app.mdx index 01f33b3..d7307a0 100644 --- a/content/docs/quick-start/build-first-app.mdx +++ b/content/docs/quick-start/build-first-app.mdx @@ -321,17 +321,17 @@ npm run validate diff --git a/content/docs/specifications/architecture/index.mdx b/content/docs/specifications/architecture/index.mdx index 57d5d43..f347432 100644 --- a/content/docs/specifications/architecture/index.mdx +++ b/content/docs/specifications/architecture/index.mdx @@ -9,21 +9,21 @@ The ObjectStack Protocol is built on three core layers that work together to pro ## Core Layers -### [Data Layer (ObjectQL)](/docs/specifications/architecture/data-layer) +### [Data Layer (ObjectQL)](../../specifications/architecture/data-layer) The Data Layer defines the "Shape of Data" and business logic. It includes: - **Schema**: Objects and Fields with 23+ field types - **Logic**: Workflows, Triggers, Validation Rules, Formulas - **Security**: Permissions and Sharing Rules - **Query**: Abstract Syntax Tree (AST) for unified data access -### [UI Layer (ObjectUI)](/docs/specifications/architecture/ui-layer) +### [UI Layer (ObjectUI)](../../specifications/architecture/ui-layer) The UI Layer defines the "Shape of Interaction" for rendering interfaces: - **Views**: Grid, Kanban, Calendar, Gantt, List configurations - **Pages**: FlexiPage layouts with regions and components - **Navigation**: App menus and navigation structures - **Analytics**: Reports and Dashboards with widgets -### [System Layer (ObjectOS)](/docs/specifications/architecture/system-layer) +### [System Layer (ObjectOS)](../../specifications/architecture/system-layer) The System Layer defines the "Runtime Environment": - **Manifest**: Application packaging - **Identity**: Authentication, Roles, Licenses diff --git a/content/docs/specifications/data/index.mdx b/content/docs/specifications/data/index.mdx index 0f15f9d..b76f984 100644 --- a/content/docs/specifications/data/index.mdx +++ b/content/docs/specifications/data/index.mdx @@ -17,25 +17,25 @@ The **Data Protocol (ObjectQL)** is the foundation of ObjectStack. It defines ho } title="Architecture" - href="/docs/specifications/data/architecture" + href="../../specifications/data/architecture" description="High-level overview of the Data Layer design and philosophy" /> } title="Schema Definition" - href="/docs/specifications/data/schema-definition" + href="../../specifications/data/schema-definition" description="How to define Objects, Fields, and Relationships" /> } title="Query AST Structure" - href="/docs/specifications/data/ast-structure" + href="../../specifications/data/ast-structure" description="Abstract Syntax Tree for database-agnostic queries" /> } title="Advanced Types" - href="/docs/specifications/data/advanced-types" + href="../../specifications/data/advanced-types" description="Complex field types and their implementations" /> @@ -44,17 +44,17 @@ The **Data Protocol (ObjectQL)** is the foundation of ObjectStack. It defines ho ### Core Specifications -1. **[Architecture Overview](/docs/specifications/data/architecture)** +1. **[Architecture Overview](../../specifications/data/architecture)** - Design principles - Layer responsibilities - Driver model -2. **[Schema Definition](/docs/specifications/data/schema-definition)** +2. **[Schema Definition](../../specifications/data/schema-definition)** - Object schema structure - Field type definitions - Relationship modeling -3. **[Advanced Types](/docs/specifications/data/advanced-types)** +3. **[Advanced Types](../../specifications/data/advanced-types)** - Formula fields - Lookup relationships - Master-detail relationships @@ -62,25 +62,25 @@ The **Data Protocol (ObjectQL)** is the foundation of ObjectStack. It defines ho ### Query Layer -4. **[AST Structure](/docs/specifications/data/ast-structure)** +4. **[AST Structure](../../specifications/data/ast-structure)** - Query Abstract Syntax Tree - Filter expressions - Aggregations - Joins and includes -5. **[Analytics Protocol](/docs/specifications/data/analytics-protocol)** +5. **[Analytics Protocol](../../specifications/data/analytics-protocol)** - Grouping and aggregation - Calculated fields - Time-series queries ### System Specifications -6. **[Transaction Model](/docs/specifications/data/transaction-model)** +6. **[Transaction Model](../../specifications/data/transaction-model)** - ACID guarantees - Isolation levels - Distributed transactions -7. **[Wire Protocol](/docs/specifications/data/wire-protocol)** +7. **[Wire Protocol](../../specifications/data/wire-protocol)** - Data serialization format - Network protocol - Compression and optimization @@ -90,16 +90,16 @@ The **Data Protocol (ObjectQL)** is the foundation of ObjectStack. It defines ho ### For Implementers Building a driver for ObjectStack? Start here: -- [Driver Interface](/docs/references/system/Driver) -- [Query Compiler](/docs/guides/custom-driver) -- [Test Suite](/docs/guides/driver-testing) +- [Driver Interface](../../references/system/Driver) +- [Query Compiler](../../guides/custom-driver) +- [Test Suite](../../guides/driver-testing) ### For Users Using ObjectStack to build applications? See: -- [Field Types Guide](/docs/guides/field-types) -- [Query Examples](/docs/guides/querying-data) -- [Business Logic](/docs/guides/workflows-validation) +- [Field Types Guide](../../guides/field-types) +- [Query Examples](../../guides/querying-data) +- [Business Logic](../../guides/workflows-validation) ## Design Principles @@ -144,6 +144,6 @@ const withSort = { ...withFilter, sort: [...] }; ## Related Documentation -- **[UI Protocol](/docs/specifications/ui/sdui-protocol)** - How to render data -- **[System Protocol](/docs/specifications/server/kernel-architecture)** - Runtime environment -- **[API Protocol](/docs/references/api/envelopes/BaseResponse)** - REST/GraphQL contracts +- **[UI Protocol](../../specifications/ui/sdui-protocol)** - How to render data +- **[System Protocol](../../specifications/server/kernel-architecture)** - Runtime environment +- **[API Protocol](../../references/api/envelopes/BaseResponse)** - REST/GraphQL contracts diff --git a/content/docs/specifications/index.mdx b/content/docs/specifications/index.mdx index dff4982..a4910c1 100644 --- a/content/docs/specifications/index.mdx +++ b/content/docs/specifications/index.mdx @@ -13,19 +13,19 @@ The ObjectStack Protocol is defined through three core specifications that work } title="Data Protocol (ObjectQL)" - href="/docs/specifications/data" + href="../specifications/data" description="Define data structures, queries, and business logic. Database-agnostic abstraction layer." /> } title="UI Protocol (ObjectUI)" - href="/docs/specifications/ui" + href="../specifications/ui" description="Server-driven UI definitions. Express interfaces as JSON, not code." /> } title="System Protocol (ObjectOS)" - href="/docs/specifications/server" + href="../specifications/server" description="Runtime kernel, plugins, security, and integration. The platform foundation." /> @@ -50,9 +50,9 @@ Building an ObjectStack implementation? - **Renderer Developers:** Build UI renderers (React, Vue, Flutter) Start with: -1. [System Protocol - Kernel Architecture](/docs/specifications/server/kernel-architecture) -2. [Data Protocol - Architecture](/docs/specifications/data/architecture) -3. [UI Protocol - SDUI Protocol](/docs/specifications/ui/sdui-protocol) +1. [System Protocol - Kernel Architecture](../specifications/server/kernel-architecture) +2. [Data Protocol - Architecture](../specifications/data/architecture) +3. [UI Protocol - SDUI Protocol](../specifications/ui/sdui-protocol) ### Platform Architects @@ -63,9 +63,9 @@ Evaluating ObjectStack for your organization? - **Solution Architects:** Design integration patterns Start with: -1. [Data Protocol - Architecture](/docs/specifications/data/architecture) -2. [System Protocol - Permission Governance](/docs/specifications/server/permission-governance) -3. [UI Protocol - Component Schema](/docs/specifications/ui/component-schema) +1. [Data Protocol - Architecture](../specifications/data/architecture) +2. [System Protocol - Permission Governance](../specifications/server/permission-governance) +3. [UI Protocol - Component Schema](../specifications/ui/component-schema) ### Advanced Users @@ -76,9 +76,9 @@ Building complex applications with ObjectStack? - **Integration Engineers:** Connect external systems Start with: -1. [Data Protocol - AST Structure](/docs/specifications/data/ast-structure) -2. [System Protocol - Plugin Manifest](/docs/specifications/server/plugin-manifest) -3. [UI Protocol - Action Triggers](/docs/specifications/ui/action-triggers) +1. [Data Protocol - AST Structure](../specifications/data/ast-structure) +2. [System Protocol - Plugin Manifest](../specifications/server/plugin-manifest) +3. [UI Protocol - Action Triggers](../specifications/ui/action-triggers) ## Specification Structure @@ -239,7 +239,7 @@ Want to propose changes or additions? ## Related Documentation -- **[Concepts](/docs/concepts/architecture)** - High-level philosophy -- **[Guides](/docs/guides/getting-started)** - Practical how-to guides -- **[References](/docs/references/data/core/Object)** - Complete API documentation +- **[Concepts](../concepts/architecture)** - High-level philosophy +- **[Guides](../guides/getting-started)** - Practical how-to guides +- **[References](../references/data/core/Object)** - Complete API documentation - **[Examples](https://github.com/objectstack-ai/spec/tree/main/examples)** - Reference implementations diff --git a/content/docs/specifications/server/index.mdx b/content/docs/specifications/server/index.mdx index e1b4c5d..fd7185d 100644 --- a/content/docs/specifications/server/index.mdx +++ b/content/docs/specifications/server/index.mdx @@ -18,25 +18,25 @@ The **System Protocol (ObjectOS)** defines the runtime environment for ObjectSta } title="Kernel Architecture" - href="/docs/specifications/server/kernel-architecture" + href="../../specifications/server/kernel-architecture" description="Core runtime engine that orchestrates all components" /> } title="Plugin Manifest" - href="/docs/specifications/server/plugin-manifest" + href="../../specifications/server/plugin-manifest" description="Package structure and plugin loading mechanism" /> } title="Permission Governance" - href="/docs/specifications/server/permission-governance" + href="../../specifications/server/permission-governance" description="Multi-layered access control and security" /> } title="REST API" - href="/docs/specifications/server/rest-api" + href="../../specifications/server/rest-api" description="Auto-generated API specification" /> @@ -45,31 +45,31 @@ The **System Protocol (ObjectOS)** defines the runtime environment for ObjectSta ### Core System -1. **[Kernel Architecture](/docs/specifications/server/kernel-architecture)** +1. **[Kernel Architecture](../../specifications/server/kernel-architecture)** - Kernel design and responsibilities - Component lifecycle - Event system - Dependency injection -2. **[Plugin Manifest](/docs/specifications/server/plugin-manifest)** +2. **[Plugin Manifest](../../specifications/server/plugin-manifest)** - Manifest structure (`objectstack.config.ts`) - Plugin metadata - Dependencies and versioning -3. **[Workflow Engine](/docs/specifications/server/workflow-engine)** +3. **[Workflow Engine](../../specifications/server/workflow-engine)** - Trigger types (before/after insert/update/delete) - Action execution - Error handling ### Security & Compliance -4. **[Permission Governance](/docs/specifications/server/permission-governance)** +4. **[Permission Governance](../../specifications/server/permission-governance)** - Object-level permissions - Field-level security - Row-level sharing - Territory management -5. **[Audit & Compliance](/docs/specifications/server/audit-compliance)** +5. **[Audit & Compliance](../../specifications/server/audit-compliance)** - Field history tracking - Login history - API usage logs @@ -77,12 +77,12 @@ The **System Protocol (ObjectOS)** defines the runtime environment for ObjectSta ### Integration -6. **[Automation Rules](/docs/specifications/server/automation-rules)** +6. **[Automation Rules](../../specifications/server/automation-rules)** - Field updates - Email alerts - Process automation -7. **[Integration & ETL](/docs/specifications/server/integration-etl)** +7. **[Integration & ETL](../../specifications/server/integration-etl)** - Webhook definitions - External API calls - Data transformation @@ -90,7 +90,7 @@ The **System Protocol (ObjectOS)** defines the runtime environment for ObjectSta ### API Layer -8. **[REST API](/docs/specifications/server/rest-api)** +8. **[REST API](../../specifications/server/rest-api)** - Endpoint structure - Request/Response format - Authentication @@ -364,19 +364,19 @@ onLoad(kernel: IKernel) { ### For Implementers Building a kernel implementation? Start here: -- [Kernel Interface](/docs/references/types/IKernel) -- [Plugin Development](/docs/guides/plugin-development) -- [Test Suite](/docs/guides/kernel-testing) +- [Kernel Interface](../../references/types/IKernel) +- [Plugin Development](../../guides/plugin-development) +- [Test Suite](../../guides/kernel-testing) ### For Users Deploying ObjectStack applications? See: -- [Installation Guide](/docs/guides/installation) -- [Configuration Reference](/docs/guides/configuration) -- [Deployment Guide](/docs/guides/deployment) +- [Installation Guide](../../guides/installation) +- [Configuration Reference](../../guides/configuration) +- [Deployment Guide](../../guides/deployment) ## Related Documentation -- **[Data Protocol](/docs/specifications/data/architecture)** - Data layer -- **[UI Protocol](/docs/specifications/ui/sdui-protocol)** - UI layer -- **[System Reference](/docs/references/system/config/Manifest)** - Configuration API +- **[Data Protocol](../../specifications/data/architecture)** - Data layer +- **[UI Protocol](../../specifications/ui/sdui-protocol)** - UI layer +- **[System Reference](../../references/system/config/Manifest)** - Configuration API diff --git a/content/docs/specifications/server/rest-api.cn.mdx b/content/docs/specifications/server/rest-api.cn.mdx index c2bc9d3..5ffaa2e 100644 --- a/content/docs/specifications/server/rest-api.cn.mdx +++ b/content/docs/specifications/server/rest-api.cn.mdx @@ -97,4 +97,4 @@ ObjectStack 遵循 "Protocol First" 原则，提供了一套标准化的 RESTful 开发者可以通过 `ApiEndpointSchema` 定义自定义的 API 接口，这些接口通常挂载在 `/api/v1/custom` 下或自定义路径。 -详见 [Custom API Guide](/docs/specifications/server/custom-api). +详见 [Custom API Guide](../../specifications/server/custom-api). diff --git a/content/docs/specifications/server/rest-api.mdx b/content/docs/specifications/server/rest-api.mdx index ce5f5db..ac450f0 100644 --- a/content/docs/specifications/server/rest-api.mdx +++ b/content/docs/specifications/server/rest-api.mdx @@ -97,4 +97,4 @@ Based on the base path returned by `routes.metadata` (default is `/api/v1/meta`) Developers can define custom API interfaces via `ApiEndpointSchema`, which are typically mounted under `/api/v1/custom` or a custom path. -See [Custom API Guide](/docs/specifications/server/custom-api). +See [Custom API Guide](../../specifications/server/custom-api). diff --git a/content/docs/specifications/ui/index.mdx b/content/docs/specifications/ui/index.mdx index cf79ecc..0196bc1 100644 --- a/content/docs/specifications/ui/index.mdx +++ b/content/docs/specifications/ui/index.mdx @@ -20,25 +20,25 @@ ObjectUI: Define JSON → Instant Update → No Rebuild Needed } title="SDUI Protocol" - href="/docs/specifications/ui/sdui-protocol" + href="../../specifications/ui/sdui-protocol" description="Server-Driven UI architecture and philosophy" /> } title="Component Schema" - href="/docs/specifications/ui/component-schema" + href="../../specifications/ui/component-schema" description="How UI components are defined and composed" /> } title="View Protocol" - href="/docs/specifications/ui/view-protocol" + href="../../specifications/ui/view-protocol" description="List views, forms, and data visualization" /> } title="Layout System" - href="/docs/specifications/ui/layout-system" + href="../../specifications/ui/layout-system" description="Grid-based responsive layout engine" /> @@ -47,29 +47,29 @@ ObjectUI: Define JSON → Instant Update → No Rebuild Needed ### View Types -1. **[SDUI Protocol](/docs/specifications/ui/sdui-protocol)** +1. **[SDUI Protocol](../../specifications/ui/sdui-protocol)** - Server-Driven UI philosophy - JSON-based component definitions - Renderer architecture -2. **[View Protocol](/docs/specifications/ui/view-protocol)** +2. **[View Protocol](../../specifications/ui/view-protocol)** - ListView (Grid, Kanban, Calendar, Gantt) - FormView (Simple, Tabbed, Wizard) - DetailView (Record pages) -3. **[Component Schema](/docs/specifications/ui/component-schema)** +3. **[Component Schema](../../specifications/ui/component-schema)** - Button, Input, Select components - Custom component registration - Component props and events ### Layout & Styling -4. **[Layout System](/docs/specifications/ui/layout-system)** +4. **[Layout System](../../specifications/ui/layout-system)** - Grid-based layouts - Responsive breakpoints - Flexbox patterns -5. **[Action Triggers](/docs/specifications/ui/action-triggers)** +5. **[Action Triggers](../../specifications/ui/action-triggers)** - Button actions - URL navigation - Flow launches @@ -77,7 +77,7 @@ ObjectUI: Define JSON → Instant Update → No Rebuild Needed ### Analytics & Reporting -6. **[Report Template](/docs/specifications/ui/report-template)** +6. **[Report Template](../../specifications/ui/report-template)** - Report types (Tabular, Summary, Matrix) - Chart configurations - Dashboard widgets @@ -260,19 +260,19 @@ ObjectUI is a protocol. Multiple renderers can implement it: ### For Implementers Building a renderer for ObjectUI? Start here: -- [Renderer Interface](/docs/references/ui/Renderer) -- [Component Registry](/docs/guides/custom-components) -- [Test Suite](/docs/guides/renderer-testing) +- [Renderer Interface](../../references/ui/Renderer) +- [Component Registry](../../guides/custom-components) +- [Test Suite](../../guides/renderer-testing) ### For Users Using ObjectUI to build interfaces? See: -- [View Configuration Guide](/docs/guides/view-configuration) -- [Theming Guide](/docs/guides/theming) -- [Dashboard Examples](/docs/tutorials/dashboards) +- [View Configuration Guide](../../guides/view-configuration) +- [Theming Guide](../../guides/theming) +- [Dashboard Examples](../../specifications/ui/dashboard) ## Related Documentation -- **[Data Protocol](/docs/specifications/data/architecture)** - How to query data -- **[System Protocol](/docs/specifications/server/kernel-architecture)** - Runtime environment -- **[UI Reference](/docs/references/ui/views/View)** - Complete API reference +- **[Data Protocol](../../specifications/data/architecture)** - How to query data +- **[System Protocol](../../specifications/server/kernel-architecture)** - Runtime environment +- **[UI Reference](../../references/ui/views/View)** - Complete API reference diff --git a/content/docs/standards/index.mdx b/content/docs/standards/index.mdx index 94ef5ea..c6634c0 100644 --- a/content/docs/standards/index.mdx +++ b/content/docs/standards/index.mdx @@ -9,25 +9,25 @@ This section documents the standards, conventions, and best practices for workin ## Protocol Standards -### [Naming Conventions](/docs/standards/naming-conventions) +### [Naming Conventions](../standards/naming-conventions) Learn the naming rules for schemas, fields, and identifiers: - Configuration keys use `camelCase` - Machine names use `snake_case` - Schema property naming patterns -### [API Design](/docs/standards/api-design) +### [API Design](../standards/api-design) API design principles and patterns for building consistent interfaces: - RESTful conventions - Request/Response envelopes - Error handling patterns -### [Error Handling](/docs/standards/error-handling) +### [Error Handling](../standards/error-handling) Consistent error handling strategies across the protocol: - Error types and codes - Error messages and localization - Recovery strategies -### [Authentication](/docs/standards/authentication) +### [Authentication](../standards/authentication) Authentication provider implementation standards: - OAuth, SAML, LDAP integration - Session management diff --git a/content/docs/troubleshooting.mdx b/content/docs/troubleshooting.mdx index e86fc0b..b5ed4c8 100644 --- a/content/docs/troubleshooting.mdx +++ b/content/docs/troubleshooting.mdx @@ -496,4 +496,4 @@ If you're still stuck after trying these solutions: - Minimal reproduction example 4. **Check the FAQ:** - - [Frequently Asked Questions](/docs/faq) + - [Frequently Asked Questions](./faq) diff --git a/content/docs/tutorials.mdx b/content/docs/tutorials.mdx index 754ded1..545434f 100644 --- a/content/docs/tutorials.mdx +++ b/content/docs/tutorials.mdx @@ -10,17 +10,17 @@ Learn ObjectStack through practical, hands-on tutorials. Each tutorial is design @@ -32,22 +32,22 @@ Learn ObjectStack through practical, hands-on tutorials. Each tutorial is design @@ -57,17 +57,17 @@ Learn ObjectStack through practical, hands-on tutorials. Each tutorial is design @@ -77,17 +77,17 @@ Learn ObjectStack through practical, hands-on tutorials. Each tutorial is design @@ -111,12 +111,12 @@ Not sure where to start? Follow this recommended path: ### 1. Start with Quick Start -Complete [Build Your First App](/docs/quick-start/build-first-app) (10 minutes) +Complete [Build Your First App](./quick-start/build-first-app) (10 minutes) ### 2. Choose Your Path -- **Backend Focus:** [Field Types](/docs/tutorials/field-types) → [Formulas](/docs/tutorials/formulas) → [Workflows](/docs/tutorials/workflows) -- **Frontend Focus:** [Custom Views](/docs/tutorials/custom-views) → [Forms](/docs/tutorials/forms) → [Dashboards](/docs/tutorials/dashboards) -- **Full-Stack:** [CRM System](/docs/tutorials/crm-system) → [Multi-Tenancy](/docs/tutorials/multi-tenancy) +- **Backend Focus:** [Field Types](./guides/field-types) → [Formulas](./specifications/data/formula) → [Workflows](./guides/workflows-validation) +- **Frontend Focus:** [Custom Views](./guides/view-configuration) → [Forms](./guides/view-configuration) → [Dashboards](./specifications/ui/dashboard) +- **Full-Stack:** [CRM System](https://github.com/objectstack-ai/spec/tree/main/examples/crm) → [Multi-Tenancy](./guides/advanced/multi-tenancy) ### 3. Build Your Own Apply what you've learned to build your own application! @@ -132,6 +132,6 @@ Check out community-contributed examples: ## Get Help Stuck on a tutorial? -- Check the [Troubleshooting Guide](/docs/guides/troubleshooting) +- Check the [Troubleshooting Guide](./troubleshooting) - Ask in [GitHub Discussions](https://github.com/objectstack-ai/spec/discussions) -- Review the [FAQ](/docs/guides/faq) +- Review the [FAQ](./faq) From c3525ee23733e6009a1f1403a128299b8031ae6f Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 23 Jan 2026 01:15:26 +0000 Subject: [PATCH 03/11] Fix broken tutorial links to point to existing reference pages Co-authored-by: xuyushun441-sys <255036401+xuyushun441-sys@users.noreply.github.com> --- content/docs/tutorials.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/content/docs/tutorials.mdx b/content/docs/tutorials.mdx index 545434f..e974120 100644 --- a/content/docs/tutorials.mdx +++ b/content/docs/tutorials.mdx @@ -37,7 +37,7 @@ Learn ObjectStack through practical, hands-on tutorials. Each tutorial is design /> @@ -114,8 +114,8 @@ Not sure where to start? Follow this recommended path: Complete [Build Your First App](./quick-start/build-first-app) (10 minutes) ### 2. Choose Your Path -- **Backend Focus:** [Field Types](./guides/field-types) → [Formulas](./specifications/data/formula) → [Workflows](./guides/workflows-validation) -- **Frontend Focus:** [Custom Views](./guides/view-configuration) → [Forms](./guides/view-configuration) → [Dashboards](./specifications/ui/dashboard) +- **Backend Focus:** [Field Types](./guides/field-types) → [Formulas](./references/data/core/Field) → [Workflows](./guides/workflows-validation) +- **Frontend Focus:** [Custom Views](./guides/view-configuration) → [Forms](./guides/view-configuration) → [Dashboards](./references/ui/analytics/Dashboard) - **Full-Stack:** [CRM System](https://github.com/objectstack-ai/spec/tree/main/examples/crm) → [Multi-Tenancy](./guides/advanced/multi-tenancy) ### 3. Build Your Own From e259674105a54717a30c98af25ad8603c87e054b Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 23 Jan 2026 01:36:09 +0000 Subject: [PATCH 04/11] Fix Card component hrefs to use absolute /docs/ paths Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com> --- content/docs/index.cn.mdx | 8 ++++---- content/docs/index.mdx | 16 +++++++-------- content/docs/quick-start/architects.mdx | 8 ++++---- .../docs/quick-start/backend-developers.mdx | 8 ++++---- content/docs/quick-start/build-first-app.mdx | 6 +++--- .../docs/quick-start/frontend-developers.mdx | 8 ++++---- content/docs/specifications/data/index.mdx | 8 ++++---- content/docs/specifications/index.mdx | 6 +++--- content/docs/specifications/server/index.mdx | 8 ++++---- content/docs/specifications/ui/index.mdx | 8 ++++---- content/docs/tutorials.mdx | 20 +++++++++---------- 11 files changed, 52 insertions(+), 52 deletions(-) diff --git a/content/docs/index.cn.mdx b/content/docs/index.cn.mdx index ccc5ce1..e4b26f6 100644 --- a/content/docs/index.cn.mdx +++ b/content/docs/index.cn.mdx @@ -16,25 +16,25 @@ import { Book, Compass, FileText, Layers } from 'lucide-react'; } title="快速开始" - href="./guides/getting-started" + href="/docs/guides/getting-started" description="5 分钟内构建你的第一个对象。通过实际示例学习基础知识。" /> } title="概念" - href="./concepts/manifesto" + href="/docs/concepts/manifesto" description="理解「意图优于实现」和「本地优先」架构的理念。" /> } title="规范" - href="./specifications/data/architecture" + href="/docs/specifications/data/architecture" description="架构蓝图。深入了解 ObjectQL（数据）、ObjectUI（视图）和 ObjectOS（控制）。" /> } title="协议参考" - href="./references/data/core/Object" + href="/docs/references/data/core/Object" description="字典。每个模式、字段类型和配置选项的全面参考。" /> diff --git a/content/docs/index.mdx b/content/docs/index.mdx index b542800..f2cade6 100644 --- a/content/docs/index.mdx +++ b/content/docs/index.mdx @@ -16,25 +16,25 @@ This documentation is the authoritative reference for the ObjectStack Protocol. } title="Quick Start" - href="./quick-start" + href="/docs/quick-start" description="Get started in under 5 minutes. Choose your learning path based on your role." /> } title="Tutorials" - href="./tutorials" + href="/docs/tutorials" description="Hands-on step-by-step tutorials to build real applications and learn by doing." /> } title="Concepts" - href="./concepts/manifesto" + href="/docs/concepts/manifesto" description="Understand the philosophy of 'Intent over Implementation' and the 'Local-First' architecture." /> } title="Specifications" - href="./specifications" + href="/docs/specifications" description="The Architecture Blueprints. Deep dive into ObjectQL (Data), ObjectUI (View), and ObjectOS (Control)." /> @@ -45,25 +45,25 @@ This documentation is the authoritative reference for the ObjectStack Protocol. } title="Developer Guides" - href="./guides/getting-started" + href="/docs/guides/getting-started" description="Comprehensive guides for building with ObjectStack. Field types, views, workflows, and more." /> } title="API Reference" - href="./references/data/core/Object" + href="/docs/references/data/core/Object" description="Complete API documentation for every schema, field type, and configuration option." /> } title="FAQ" - href="./faq" + href="/docs/faq" description="Frequently asked questions about ObjectStack and how to use it." /> } title="Troubleshooting" - href="./troubleshooting" + href="/docs/troubleshooting" description="Common issues and how to resolve them." /> diff --git a/content/docs/quick-start/architects.mdx b/content/docs/quick-start/architects.mdx index 8d2715f..87ad624 100644 --- a/content/docs/quick-start/architects.mdx +++ b/content/docs/quick-start/architects.mdx @@ -475,22 +475,22 @@ app.get('/legacy', legacyController); diff --git a/content/docs/quick-start/backend-developers.mdx b/content/docs/quick-start/backend-developers.mdx index 2e88708..7ce01f3 100644 --- a/content/docs/quick-start/backend-developers.mdx +++ b/content/docs/quick-start/backend-developers.mdx @@ -366,22 +366,22 @@ describe('Task Object', () => { diff --git a/content/docs/quick-start/build-first-app.mdx b/content/docs/quick-start/build-first-app.mdx index d7307a0..01f33b3 100644 --- a/content/docs/quick-start/build-first-app.mdx +++ b/content/docs/quick-start/build-first-app.mdx @@ -321,17 +321,17 @@ npm run validate diff --git a/content/docs/specifications/data/index.mdx b/content/docs/specifications/data/index.mdx index b76f984..0a5400a 100644 --- a/content/docs/specifications/data/index.mdx +++ b/content/docs/specifications/data/index.mdx @@ -17,25 +17,25 @@ The **Data Protocol (ObjectQL)** is the foundation of ObjectStack. It defines ho } title="Architecture" - href="../../specifications/data/architecture" + href="/docs/specifications/data/architecture" description="High-level overview of the Data Layer design and philosophy" /> } title="Schema Definition" - href="../../specifications/data/schema-definition" + href="/docs/specifications/data/schema-definition" description="How to define Objects, Fields, and Relationships" /> } title="Query AST Structure" - href="../../specifications/data/ast-structure" + href="/docs/specifications/data/ast-structure" description="Abstract Syntax Tree for database-agnostic queries" /> } title="Advanced Types" - href="../../specifications/data/advanced-types" + href="/docs/specifications/data/advanced-types" description="Complex field types and their implementations" /> diff --git a/content/docs/specifications/index.mdx b/content/docs/specifications/index.mdx index a4910c1..9ca4bcd 100644 --- a/content/docs/specifications/index.mdx +++ b/content/docs/specifications/index.mdx @@ -13,19 +13,19 @@ The ObjectStack Protocol is defined through three core specifications that work } title="Data Protocol (ObjectQL)" - href="../specifications/data" + href="/docs/specifications/data" description="Define data structures, queries, and business logic. Database-agnostic abstraction layer." /> } title="UI Protocol (ObjectUI)" - href="../specifications/ui" + href="/docs/specifications/ui" description="Server-driven UI definitions. Express interfaces as JSON, not code." /> } title="System Protocol (ObjectOS)" - href="../specifications/server" + href="/docs/specifications/server" description="Runtime kernel, plugins, security, and integration. The platform foundation." /> diff --git a/content/docs/specifications/server/index.mdx b/content/docs/specifications/server/index.mdx index fd7185d..3c9e72d 100644 --- a/content/docs/specifications/server/index.mdx +++ b/content/docs/specifications/server/index.mdx @@ -18,25 +18,25 @@ The **System Protocol (ObjectOS)** defines the runtime environment for ObjectSta } title="Kernel Architecture" - href="../../specifications/server/kernel-architecture" + href="/docs/specifications/server/kernel-architecture" description="Core runtime engine that orchestrates all components" /> } title="Plugin Manifest" - href="../../specifications/server/plugin-manifest" + href="/docs/specifications/server/plugin-manifest" description="Package structure and plugin loading mechanism" /> } title="Permission Governance" - href="../../specifications/server/permission-governance" + href="/docs/specifications/server/permission-governance" description="Multi-layered access control and security" /> } title="REST API" - href="../../specifications/server/rest-api" + href="/docs/specifications/server/rest-api" description="Auto-generated API specification" /> diff --git a/content/docs/specifications/ui/index.mdx b/content/docs/specifications/ui/index.mdx index 0196bc1..0075d80 100644 --- a/content/docs/specifications/ui/index.mdx +++ b/content/docs/specifications/ui/index.mdx @@ -20,25 +20,25 @@ ObjectUI: Define JSON → Instant Update → No Rebuild Needed } title="SDUI Protocol" - href="../../specifications/ui/sdui-protocol" + href="/docs/specifications/ui/sdui-protocol" description="Server-Driven UI architecture and philosophy" /> } title="Component Schema" - href="../../specifications/ui/component-schema" + href="/docs/specifications/ui/component-schema" description="How UI components are defined and composed" /> } title="View Protocol" - href="../../specifications/ui/view-protocol" + href="/docs/specifications/ui/view-protocol" description="List views, forms, and data visualization" /> } title="Layout System" - href="../../specifications/ui/layout-system" + href="/docs/specifications/ui/layout-system" description="Grid-based responsive layout engine" /> diff --git a/content/docs/tutorials.mdx b/content/docs/tutorials.mdx index e974120..5116d65 100644 --- a/content/docs/tutorials.mdx +++ b/content/docs/tutorials.mdx @@ -32,22 +32,22 @@ Learn ObjectStack through practical, hands-on tutorials. Each tutorial is design @@ -57,17 +57,17 @@ Learn ObjectStack through practical, hands-on tutorials. Each tutorial is design @@ -77,17 +77,17 @@ Learn ObjectStack through practical, hands-on tutorials. Each tutorial is design From 298364464024c80853c5fe4740f908395e71114c Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 23 Jan 2026 01:47:50 +0000 Subject: [PATCH 05/11] Convert all markdown links to absolute /docs/ paths Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com> --- content/docs/faq.mdx | 4 +-- .../guides/advanced/ai-integration-guide.mdx | 12 +++---- .../advanced/ai-integration/quick-start.mdx | 10 +++--- .../advanced/security/best-practices.mdx | 2 +- content/docs/guides/field-types.cn.mdx | 10 +++--- content/docs/guides/field-types.mdx | 10 +++--- content/docs/guides/getting-started.cn.mdx | 8 ++--- content/docs/guides/getting-started.mdx | 8 ++--- content/docs/guides/migration/index.mdx | 2 +- content/docs/guides/migration/v0-to-v1.mdx | 4 +-- content/docs/guides/view-configuration.mdx | 6 ++-- content/docs/guides/workflows-validation.mdx | 6 ++-- content/docs/index.cn.mdx | 14 ++++---- content/docs/index.mdx | 14 ++++---- content/docs/quick-start.mdx | 6 ++-- .../docs/quick-start/backend-developers.mdx | 8 ++--- .../architecture/data-layer.mdx | 10 +++--- .../specifications/architecture/index.mdx | 6 ++-- .../architecture/system-layer.mdx | 10 +++--- .../specifications/architecture/ui-layer.mdx | 10 +++--- .../specifications/data/architecture.cn.mdx | 6 ++-- .../docs/specifications/data/architecture.mdx | 6 ++-- content/docs/specifications/data/index.mdx | 32 ++++++++--------- .../specifications/data/schema-definition.mdx | 2 +- content/docs/specifications/index.mdx | 24 ++++++------- content/docs/specifications/server/index.mdx | 34 +++++++++---------- .../specifications/server/rest-api.cn.mdx | 2 +- .../docs/specifications/server/rest-api.mdx | 2 +- content/docs/specifications/ui/index.mdx | 30 ++++++++-------- content/docs/standards/api-design.mdx | 6 ++-- content/docs/standards/authentication.mdx | 4 +-- content/docs/standards/error-handling.mdx | 4 +-- content/docs/standards/index.mdx | 8 ++--- content/docs/standards/naming-conventions.mdx | 2 +- content/docs/troubleshooting.mdx | 2 +- content/docs/tutorials.mdx | 12 +++---- 36 files changed, 168 insertions(+), 168 deletions(-) diff --git a/content/docs/faq.mdx b/content/docs/faq.mdx index 3f5d6cd..77ff46f 100644 --- a/content/docs/faq.mdx +++ b/content/docs/faq.mdx @@ -169,7 +169,7 @@ ObjectStack apps are standard Node.js applications. Deploy like any Node app: - **Serverless:** AWS Lambda, Google Cloud Functions - **PaaS:** Heroku, Railway, Render -See the [Deployment Guide](./guides/deployment) for details. +See the [Deployment Guide](/docs/guides/deployment) for details. ## Development Questions @@ -306,7 +306,7 @@ Field.lookup({ ## Still Have Questions? -- 📖 Check the [Guides](./guides/getting-started) +- 📖 Check the [Guides](/docs/guides/getting-started) - 💬 Ask in [GitHub Discussions](https://github.com/objectstack-ai/spec/discussions) - 🐛 Report bugs in [GitHub Issues](https://github.com/objectstack-ai/spec/issues) - 📧 Email: support@objectstack.dev (for urgent issues) diff --git a/content/docs/guides/advanced/ai-integration-guide.mdx b/content/docs/guides/advanced/ai-integration-guide.mdx index a8d52d2..344f70e 100644 --- a/content/docs/guides/advanced/ai-integration-guide.mdx +++ b/content/docs/guides/advanced/ai-integration-guide.mdx @@ -698,7 +698,7 @@ const trainingExamples: NLQTrainingExample[] = [ ## Example Applications ### 1. AI Support Assistant -[View Example](../examples/ai-support) +[View Example](/docs/guides/examples/ai-support) **Features:** - RAG knowledge base @@ -712,7 +712,7 @@ Customer → GPT-4 Agent → RAG (Pinecone) → Actions → ObjectQL ``` ### 2. AI Data Analyst -[View Example](../examples/ai-analyst) +[View Example](/docs/guides/examples/ai-analyst) **Features:** - Natural language queries @@ -721,7 +721,7 @@ Customer → GPT-4 Agent → RAG (Pinecone) → Actions → ObjectQL - Query templates ### 3. AI Code Generator -[View Example](../examples/ai-codegen) +[View Example](/docs/guides/examples/ai-codegen) **Features:** - Generate ObjectStack apps @@ -730,7 +730,7 @@ Customer → GPT-4 Agent → RAG (Pinecone) → Actions → ObjectQL - RAG for documentation ### 4. AI Sales Assistant -[View Example](../examples/ai-sales) +[View Example](/docs/guides/examples/ai-sales) **Features:** - Lead qualification @@ -792,8 +792,8 @@ if (response.parseResult.confidence < 0.7) { ## Resources - [ObjectStack Documentation](https://docs.objectstack.ai) -- [AI Protocol Reference](../packages/spec/src/ai) -- [Example Applications](../examples) +- [AI Protocol Reference](/docs/guides/packages/spec/src/ai) +- [Example Applications](/docs/guides/examples) - [Discord Community](https://discord.gg/objectstack) --- diff --git a/content/docs/guides/advanced/ai-integration/quick-start.mdx b/content/docs/guides/advanced/ai-integration/quick-start.mdx index 80a9660..c6e7939 100644 --- a/content/docs/guides/advanced/ai-integration/quick-start.mdx +++ b/content/docs/guides/advanced/ai-integration/quick-start.mdx @@ -166,12 +166,12 @@ const generated = await ai.generate({ See the following example implementations: -- [AI Sales Assistant](../../../examples/ai-sales/) -- [AI Support Agent](../../../examples/ai-support/) -- [AI Code Generator](../../../examples/ai-codegen/) -- [AI Analyst](../../../examples/ai-analyst/) +- [AI Sales Assistant](/docs/examples/ai-sales/) +- [AI Support Agent](/docs/examples/ai-support/) +- [AI Code Generator](/docs/examples/ai-codegen/) +- [AI Analyst](/docs/examples/ai-analyst/) -For complete documentation, see [AI_INTEGRATION_GUIDE.md](../../AI_INTEGRATION_GUIDE.md) +For complete documentation, see [AI_INTEGRATION_GUIDE.md](/docs/guides/AI_INTEGRATION_GUIDE.md) --- diff --git a/content/docs/guides/advanced/security/best-practices.mdx b/content/docs/guides/advanced/security/best-practices.mdx index a232b0f..9a3823d 100644 --- a/content/docs/guides/advanced/security/best-practices.mdx +++ b/content/docs/guides/advanced/security/best-practices.mdx @@ -98,7 +98,7 @@ const authConfig = { - [ ] Audit logging enabled - [ ] Regular security updates -For detailed information, see [AUTHENTICATION_STANDARD.md](../../../AUTHENTICATION_STANDARD.md) +For detailed information, see [AUTHENTICATION_STANDARD.md](/docs/AUTHENTICATION_STANDARD.md) --- diff --git a/content/docs/guides/field-types.cn.mdx b/content/docs/guides/field-types.cn.mdx index 94e9ab4..3e9436b 100644 --- a/content/docs/guides/field-types.cn.mdx +++ b/content/docs/guides/field-types.cn.mdx @@ -451,7 +451,7 @@ days_open: Field.formula({ ``` > ℹ️ **Info:** - 公式字段自动计算且只读。可用函数请参见 [公式函数](../references/data/formulas)。 + 公式字段自动计算且只读。可用函数请参见 [公式函数](/docs/references/data/formulas)。 --- @@ -749,7 +749,7 @@ created_at: Field.datetime({ ## 下一步 -- [对象架构指南](../guides/object-schema) -- [验证规则](../guides/validation-rules) -- [工作流自动化](../guides/workflows) -- [字段 API 参考](../references/data/core/Field) +- [对象架构指南](/docs/guides/object-schema) +- [验证规则](/docs/guides/validation-rules) +- [工作流自动化](/docs/guides/workflows) +- [字段 API 参考](/docs/references/data/core/Field) diff --git a/content/docs/guides/field-types.mdx b/content/docs/guides/field-types.mdx index 9ff345b..2f1edd4 100644 --- a/content/docs/guides/field-types.mdx +++ b/content/docs/guides/field-types.mdx @@ -451,7 +451,7 @@ days_open: Field.formula({ ``` > ℹ️ **Info:** - Formula fields are automatically calculated and readonly. See [Formula Functions](../references/data/formulas) for available functions. + Formula fields are automatically calculated and readonly. See [Formula Functions](/docs/references/data/formulas) for available functions. --- @@ -749,7 +749,7 @@ See the **[CRM Example](https://github.com/objectstack-ai/spec/tree/main/example ## Next Steps -- [Object Schema Guide](../guides/object-schema) -- [Validation Rules](../guides/validation-rules) -- [Workflow Automation](../guides/workflows) -- [Field API Reference](../references/data/core/Field) +- [Object Schema Guide](/docs/guides/object-schema) +- [Validation Rules](/docs/guides/validation-rules) +- [Workflow Automation](/docs/guides/workflows) +- [Field API Reference](/docs/references/data/core/Field) diff --git a/content/docs/guides/getting-started.cn.mdx b/content/docs/guides/getting-started.cn.mdx index 24ac970..e3da5bc 100644 --- a/content/docs/guides/getting-started.cn.mdx +++ b/content/docs/guides/getting-started.cn.mdx @@ -276,14 +276,14 @@ views: { 现在你有了有效的元数据，你可以： 1. **探索示例**：查看 [CRM 示例](https://github.com/objectstack-ai/spec/tree/main/examples/crm) 了解完整功能实现 -2. **学习字段类型**：参见 [字段类型指南](../guides/field-types) 了解所有 30+ 种字段类型 +2. **学习字段类型**：参见 [字段类型指南](/docs/guides/field-types) 了解所有 30+ 种字段类型 3. **构建 UI**：使用 ObjectStack 运行时的元数据来生成界面 4. **部署**：推送到 ObjectStack 内核用于生产环境 **其他资源：** -- [对象模式参考](../references/data/core/Object) -- [验证规则](../guides/validation-rules) -- [工作流自动化](../guides/workflows) +- [对象模式参考](/docs/references/data/core/Object) +- [验证规则](/docs/guides/validation-rules) +- [工作流自动化](/docs/guides/workflows) diff --git a/content/docs/guides/getting-started.mdx b/content/docs/guides/getting-started.mdx index ee11ffd..9b042dc 100644 --- a/content/docs/guides/getting-started.mdx +++ b/content/docs/guides/getting-started.mdx @@ -276,14 +276,14 @@ views: { Now that you have valid metadata, you can: 1. **Explore Examples**: Check out the [CRM Example](https://github.com/objectstack-ai/spec/tree/main/examples/crm) for a full-featured implementation -2. **Learn Field Types**: See the [Field Types Guide](../guides/field-types) for all 30+ field types +2. **Learn Field Types**: See the [Field Types Guide](/docs/guides/field-types) for all 30+ field types 3. **Build UI**: Use the metadata with ObjectStack runtime to generate interfaces 4. **Deploy**: Push to an ObjectStack kernel for production use **Additional Resources:** -- [Object Schema Reference](../references/data/core/Object) -- [Validation Rules](../guides/validation-rules) -- [Workflow Automation](../guides/workflows) +- [Object Schema Reference](/docs/references/data/core/Object) +- [Validation Rules](/docs/guides/validation-rules) +- [Workflow Automation](/docs/guides/workflows) diff --git a/content/docs/guides/migration/index.mdx b/content/docs/guides/migration/index.mdx index 8945c85..3b0ec01 100644 --- a/content/docs/guides/migration/index.mdx +++ b/content/docs/guides/migration/index.mdx @@ -9,7 +9,7 @@ This section contains guides for migrating your applications between different v ## Available Guides -### [Version 0.x to 1.x Migration](../../guides/migration/v0-to-v1) +### [Version 0.x to 1.x Migration](/docs/guides/migration/v0-to-v1) Complete guide for migrating from version 0.x to 1.x, including: - Breaking changes - New features diff --git a/content/docs/guides/migration/v0-to-v1.mdx b/content/docs/guides/migration/v0-to-v1.mdx index ee80c7a..d5c35b8 100644 --- a/content/docs/guides/migration/v0-to-v1.mdx +++ b/content/docs/guides/migration/v0-to-v1.mdx @@ -145,8 +145,8 @@ The following features are deprecated and will be removed in v2.0.0: If you encounter issues: -1. Check the [CHANGELOG.md](../../CHANGELOG.md) -2. Review [CONTRIBUTING.md](../../CONTRIBUTING.md) +1. Check the [CHANGELOG.md](/docs/CHANGELOG.md) +2. Review [CONTRIBUTING.md](/docs/CONTRIBUTING.md) 3. Open an issue on GitHub --- diff --git a/content/docs/guides/view-configuration.mdx b/content/docs/guides/view-configuration.mdx index 089a09d..31c0f51 100644 --- a/content/docs/guides/view-configuration.mdx +++ b/content/docs/guides/view-configuration.mdx @@ -800,7 +800,7 @@ export const Opportunity = ObjectSchema.create({ ## Next Steps -- [Field Types Guide](../guides/field-types) -- [Workflows & Validation](../guides/workflows-validation) -- [Dashboard Configuration](../guides/dashboards) +- [Field Types Guide](/docs/guides/field-types) +- [Workflows & Validation](/docs/guides/workflows-validation) +- [Dashboard Configuration](/docs/guides/dashboards) - [CRM Example](https://github.com/objectstack-ai/spec/tree/main/examples/crm) - See all view types in action diff --git a/content/docs/guides/workflows-validation.mdx b/content/docs/guides/workflows-validation.mdx index cd19084..a3cf47a 100644 --- a/content/docs/guides/workflows-validation.mdx +++ b/content/docs/guides/workflows-validation.mdx @@ -727,7 +727,7 @@ export const Opportunity = ObjectSchema.create({ ## Next Steps -- [Field Types Guide](../guides/field-types) -- [Object Schema Reference](../references/data/core/Object) -- [Formula Functions](../references/data/formulas) +- [Field Types Guide](/docs/guides/field-types) +- [Object Schema Reference](/docs/references/data/core/Object) +- [Formula Functions](/docs/references/data/formulas) - [CRM Example](https://github.com/objectstack-ai/spec/tree/main/examples/crm) - See validations and workflows in action diff --git a/content/docs/index.cn.mdx b/content/docs/index.cn.mdx index e4b26f6..45b4f4f 100644 --- a/content/docs/index.cn.mdx +++ b/content/docs/index.cn.mdx @@ -42,10 +42,10 @@ import { Book, Compass, FileText, Layers } from 'lucide-react'; ## 快速链接 ### 基础指南 -- **[字段类型](./guides/field-types)** - 30+ 种字段类型及示例（文本、数字、选择、查找、公式等） -- **[视图配置](./guides/view-configuration)** - 网格、看板、日历、甘特图和表单布局 -- **[工作流与验证](./guides/workflows-validation)** - 业务规则和自动化 -- **[项目结构](./guides/project-structure)** - 组织代码的最佳实践 +- **[字段类型](/docs/guides/field-types)** - 30+ 种字段类型及示例（文本、数字、选择、查找、公式等） +- **[视图配置](/docs/guides/view-configuration)** - 网格、看板、日历、甘特图和表单布局 +- **[工作流与验证](/docs/guides/workflows-validation)** - 业务规则和自动化 +- **[项目结构](/docs/guides/project-structure)** - 组织代码的最佳实践 ### 示例 - **[CRM 示例](https://github.com/objectstack-ai/spec/tree/main/examples/crm)** - 全功能应用，包含 6 个对象、工作流、视图、仪表板 @@ -57,9 +57,9 @@ ObjectStack 建立在五个协同工作的核心模块之上： | 模块 | 协议 | 职责 | | :--- | :--- | :--- | -| **数据层** | **[ObjectQL](./specifications/data/architecture)** | 定义数据的形状（`Object`、`Field`）以及如何访问它（`Query AST`）。与 SQL/NoSQL 无关。 | -| **UI 层** | **[ObjectUI](./specifications/ui/sdui-protocol)** | 投影层。将用户界面定义为抽象的 JSON 布局（视图、仪表板、操作）。 | -| **控制层** | **[ObjectOS](./specifications/server/kernel-architecture)** | 内核。处理身份、安全、同步和自动化。 | +| **数据层** | **[ObjectQL](/docs/specifications/data/architecture)** | 定义数据的形状（`Object`、`Field`）以及如何访问它（`Query AST`）。与 SQL/NoSQL 无关。 | +| **UI 层** | **[ObjectUI](/docs/specifications/ui/sdui-protocol)** | 投影层。将用户界面定义为抽象的 JSON 布局（视图、仪表板、操作）。 | +| **控制层** | **[ObjectOS](/docs/specifications/server/kernel-architecture)** | 内核。处理身份、安全、同步和自动化。 | | **AI 层** | **AI 协议** | AI 代理定义、工具、知识库和模型配置。 | | **API 层** | **API 协议** | 标准化的 REST/GraphQL 契约，带请求/响应封装。 | diff --git a/content/docs/index.mdx b/content/docs/index.mdx index f2cade6..ce9d5a8 100644 --- a/content/docs/index.mdx +++ b/content/docs/index.mdx @@ -71,10 +71,10 @@ This documentation is the authoritative reference for the ObjectStack Protocol. ## Quick Links ### Essential Guides -- **[Field Types](./guides/field-types)** - 30+ field types with examples (text, number, select, lookup, formula, etc.) -- **[View Configuration](./guides/view-configuration)** - Grid, Kanban, Calendar, Gantt, and Form layouts -- **[Workflows & Validation](./guides/workflows-validation)** - Business rules and automation -- **[Project Structure](./guides/project-structure)** - Best practices for organizing your code +- **[Field Types](/docs/guides/field-types)** - 30+ field types with examples (text, number, select, lookup, formula, etc.) +- **[View Configuration](/docs/guides/view-configuration)** - Grid, Kanban, Calendar, Gantt, and Form layouts +- **[Workflows & Validation](/docs/guides/workflows-validation)** - Business rules and automation +- **[Project Structure](/docs/guides/project-structure)** - Best practices for organizing your code ### Examples - **[CRM Example](https://github.com/objectstack-ai/spec/tree/main/examples/crm)** - Full-featured application with 6 objects, workflows, views, dashboards @@ -86,9 +86,9 @@ ObjectStack is built on five core modules that work in unison: | Module | Protocol | Responsibility | | :--- | :--- | :--- | -| **Data Layer** | **[ObjectQL](./specifications/data/architecture)** | Defines the shape of data (`Object`, `Field`) and how to access it (`Query AST`). Agnostic to SQL/NoSQL. | -| **UI Layer** | **[ObjectUI](./specifications/ui/sdui-protocol)** | The Projection. Defines User Interfaces as abstract JSON layouts (Views, Dashboards, Actions). | -| **Control Layer** | **[ObjectOS](./specifications/server/kernel-architecture)** | The Kernel. Handles Identity, Security, Sync, and Automation. | +| **Data Layer** | **[ObjectQL](/docs/specifications/data/architecture)** | Defines the shape of data (`Object`, `Field`) and how to access it (`Query AST`). Agnostic to SQL/NoSQL. | +| **UI Layer** | **[ObjectUI](/docs/specifications/ui/sdui-protocol)** | The Projection. Defines User Interfaces as abstract JSON layouts (Views, Dashboards, Actions). | +| **Control Layer** | **[ObjectOS](/docs/specifications/server/kernel-architecture)** | The Kernel. Handles Identity, Security, Sync, and Automation. | | **AI Layer** | **AI Protocol** | AI agent definitions, tools, knowledge bases, and model configurations. | | **API Layer** | **API Protocol** | Standardized REST/GraphQL contracts with request/response envelopes. | diff --git a/content/docs/quick-start.mdx b/content/docs/quick-start.mdx index 8763499..16b5f38 100644 --- a/content/docs/quick-start.mdx +++ b/content/docs/quick-start.mdx @@ -85,9 +85,9 @@ npm install @objectstack/spec zod ### 2. Choose your learning path -- **Quick & Practical:** [Build Your First App](./quick-start/build-first-app) - Hands-on tutorial -- **Conceptual Understanding:** [Core Concepts](./concepts/manifesto) - Philosophy and architecture -- **Complete Reference:** [Developer Guides](./guides/getting-started) - Comprehensive documentation +- **Quick & Practical:** [Build Your First App](/docs/quick-start/build-first-app) - Hands-on tutorial +- **Conceptual Understanding:** [Core Concepts](/docs/concepts/manifesto) - Philosophy and architecture +- **Complete Reference:** [Developer Guides](/docs/guides/getting-started) - Comprehensive documentation ### 3. Explore examples diff --git a/content/docs/quick-start/backend-developers.mdx b/content/docs/quick-start/backend-developers.mdx index 7ce01f3..5c907d5 100644 --- a/content/docs/quick-start/backend-developers.mdx +++ b/content/docs/quick-start/backend-developers.mdx @@ -390,7 +390,7 @@ describe('Task Object', () => { Coming from another framework? We've got you covered: -- [Prisma → ObjectStack](../guides/migration/prisma) -- [TypeORM → ObjectStack](../guides/migration/typeorm) -- [Sequelize → ObjectStack](../guides/migration/sequelize) -- [Mongoose → ObjectStack](../guides/migration/mongoose) +- [Prisma → ObjectStack](/docs/guides/migration/prisma) +- [TypeORM → ObjectStack](/docs/guides/migration/typeorm) +- [Sequelize → ObjectStack](/docs/guides/migration/sequelize) +- [Mongoose → ObjectStack](/docs/guides/migration/mongoose) diff --git a/content/docs/specifications/architecture/data-layer.mdx b/content/docs/specifications/architecture/data-layer.mdx index 205330a..0da4eaf 100644 --- a/content/docs/specifications/architecture/data-layer.mdx +++ b/content/docs/specifications/architecture/data-layer.mdx @@ -276,9 +276,9 @@ const indexes = [ ## Related Documentation -- [Field Types Guide](../../content/docs/guides/field-types.mdx) -- [Query Protocol Guide](../../packages/spec/QUERY_PROTOCOL_GUIDE.md) -- [Schema Definition Specification](../../content/docs/specifications/data/schema-definition.mdx) -- [Driver Interface](../../content/docs/references/system/DriverInterface.mdx) +- [Field Types Guide](/docs/content/docs/guides/field-types.mdx) +- [Query Protocol Guide](/docs/packages/spec/QUERY_PROTOCOL_GUIDE.md) +- [Schema Definition Specification](/docs/content/docs/specifications/data/schema-definition.mdx) +- [Driver Interface](/docs/content/docs/references/system/DriverInterface.mdx) -For complete API reference, see [Data Protocol References](../../content/docs/references/data/). +For complete API reference, see [Data Protocol References](/docs/content/docs/references/data/). diff --git a/content/docs/specifications/architecture/index.mdx b/content/docs/specifications/architecture/index.mdx index f347432..57d5d43 100644 --- a/content/docs/specifications/architecture/index.mdx +++ b/content/docs/specifications/architecture/index.mdx @@ -9,21 +9,21 @@ The ObjectStack Protocol is built on three core layers that work together to pro ## Core Layers -### [Data Layer (ObjectQL)](../../specifications/architecture/data-layer) +### [Data Layer (ObjectQL)](/docs/specifications/architecture/data-layer) The Data Layer defines the "Shape of Data" and business logic. It includes: - **Schema**: Objects and Fields with 23+ field types - **Logic**: Workflows, Triggers, Validation Rules, Formulas - **Security**: Permissions and Sharing Rules - **Query**: Abstract Syntax Tree (AST) for unified data access -### [UI Layer (ObjectUI)](../../specifications/architecture/ui-layer) +### [UI Layer (ObjectUI)](/docs/specifications/architecture/ui-layer) The UI Layer defines the "Shape of Interaction" for rendering interfaces: - **Views**: Grid, Kanban, Calendar, Gantt, List configurations - **Pages**: FlexiPage layouts with regions and components - **Navigation**: App menus and navigation structures - **Analytics**: Reports and Dashboards with widgets -### [System Layer (ObjectOS)](../../specifications/architecture/system-layer) +### [System Layer (ObjectOS)](/docs/specifications/architecture/system-layer) The System Layer defines the "Runtime Environment": - **Manifest**: Application packaging - **Identity**: Authentication, Roles, Licenses diff --git a/content/docs/specifications/architecture/system-layer.mdx b/content/docs/specifications/architecture/system-layer.mdx index 76df94d..90e93ca 100644 --- a/content/docs/specifications/architecture/system-layer.mdx +++ b/content/docs/specifications/architecture/system-layer.mdx @@ -446,9 +446,9 @@ const datasource = { ## Related Documentation -- [Plugin Architecture](../../content/docs/concepts/plugin-architecture.mdx) -- [Kernel Architecture](../../content/docs/specifications/server/kernel-architecture.mdx) -- [Authentication Standard](../AUTHENTICATION_STANDARD.md) -- [System Protocol References](../../content/docs/references/system/) +- [Plugin Architecture](/docs/content/docs/concepts/plugin-architecture.mdx) +- [Kernel Architecture](/docs/content/docs/specifications/server/kernel-architecture.mdx) +- [Authentication Standard](/docs/specifications/AUTHENTICATION_STANDARD.md) +- [System Protocol References](/docs/content/docs/references/system/) -For complete API reference, see [System Protocol References](../../content/docs/references/system/). +For complete API reference, see [System Protocol References](/docs/content/docs/references/system/). diff --git a/content/docs/specifications/architecture/ui-layer.mdx b/content/docs/specifications/architecture/ui-layer.mdx index 5e0cf71..ea8e41b 100644 --- a/content/docs/specifications/architecture/ui-layer.mdx +++ b/content/docs/specifications/architecture/ui-layer.mdx @@ -359,9 +359,9 @@ const page = { ## Related Documentation -- [View Configuration Guide](../../content/docs/guides/view-configuration.mdx) -- [SDUI Protocol Specification](../../content/docs/specifications/ui/sdui-protocol.mdx) -- [Component Schema](../../content/docs/specifications/ui/component-schema.mdx) -- [UI Protocol References](../../content/docs/references/ui/) +- [View Configuration Guide](/docs/content/docs/guides/view-configuration.mdx) +- [SDUI Protocol Specification](/docs/content/docs/specifications/ui/sdui-protocol.mdx) +- [Component Schema](/docs/content/docs/specifications/ui/component-schema.mdx) +- [UI Protocol References](/docs/content/docs/references/ui/) -For complete API reference, see [UI Protocol References](../../content/docs/references/ui/). +For complete API reference, see [UI Protocol References](/docs/content/docs/references/ui/). diff --git a/content/docs/specifications/data/architecture.cn.mdx b/content/docs/specifications/data/architecture.cn.mdx index 42c5fd2..f3e5ded 100644 --- a/content/docs/specifications/data/architecture.cn.mdx +++ b/content/docs/specifications/data/architecture.cn.mdx @@ -46,9 +46,9 @@ ObjectQL 由三个核心规范组成： | 规范 | 范围 | 职责 | | :--- | :--- | :--- | -| **[Schema 定义](./schema-definition)** | 静态 | 如何定义对象、字段和关系。 | -| **[AST 结构](./ast-structure)** | 运行时 | JSON 查询对象（"IR"）的结构。 | -| **[传输协议](./wire-protocol)** | 传输 | 客户端和服务器如何通过 HTTP 交换这些结构。 | +| **[Schema 定义](/docs/specifications/data/schema-definition)** | 静态 | 如何定义对象、字段和关系。 | +| **[AST 结构](/docs/specifications/data/ast-structure)** | 运行时 | JSON 查询对象（"IR"）的结构。 | +| **[传输协议](/docs/specifications/data/wire-protocol)** | 传输 | 客户端和服务器如何通过 HTTP 交换这些结构。 | ## 设计约束 diff --git a/content/docs/specifications/data/architecture.mdx b/content/docs/specifications/data/architecture.mdx index a585876..b88cd7b 100644 --- a/content/docs/specifications/data/architecture.mdx +++ b/content/docs/specifications/data/architecture.mdx @@ -46,9 +46,9 @@ ObjectQL is comprised of three core specifications: | Specification | Scope | Responsibility | | :--- | :--- | :--- | -| **[Schema Definition](./schema-definition)** | Static | How to define Objects, Fields, and Relationships. | -| **[AST Structure](./ast-structure)** | Runtime | The structure of the JSON Query Object (The "IR"). | -| **[Wire Protocol](./wire-protocol)** | Transport | How Clients and Servers exchange these structures over HTTP. | +| **[Schema Definition](/docs/specifications/data/schema-definition)** | Static | How to define Objects, Fields, and Relationships. | +| **[AST Structure](/docs/specifications/data/ast-structure)** | Runtime | The structure of the JSON Query Object (The "IR"). | +| **[Wire Protocol](/docs/specifications/data/wire-protocol)** | Transport | How Clients and Servers exchange these structures over HTTP. | ## Design Constraints diff --git a/content/docs/specifications/data/index.mdx b/content/docs/specifications/data/index.mdx index 0a5400a..0f15f9d 100644 --- a/content/docs/specifications/data/index.mdx +++ b/content/docs/specifications/data/index.mdx @@ -44,17 +44,17 @@ The **Data Protocol (ObjectQL)** is the foundation of ObjectStack. It defines ho ### Core Specifications -1. **[Architecture Overview](../../specifications/data/architecture)** +1. **[Architecture Overview](/docs/specifications/data/architecture)** - Design principles - Layer responsibilities - Driver model -2. **[Schema Definition](../../specifications/data/schema-definition)** +2. **[Schema Definition](/docs/specifications/data/schema-definition)** - Object schema structure - Field type definitions - Relationship modeling -3. **[Advanced Types](../../specifications/data/advanced-types)** +3. **[Advanced Types](/docs/specifications/data/advanced-types)** - Formula fields - Lookup relationships - Master-detail relationships @@ -62,25 +62,25 @@ The **Data Protocol (ObjectQL)** is the foundation of ObjectStack. It defines ho ### Query Layer -4. **[AST Structure](../../specifications/data/ast-structure)** +4. **[AST Structure](/docs/specifications/data/ast-structure)** - Query Abstract Syntax Tree - Filter expressions - Aggregations - Joins and includes -5. **[Analytics Protocol](../../specifications/data/analytics-protocol)** +5. **[Analytics Protocol](/docs/specifications/data/analytics-protocol)** - Grouping and aggregation - Calculated fields - Time-series queries ### System Specifications -6. **[Transaction Model](../../specifications/data/transaction-model)** +6. **[Transaction Model](/docs/specifications/data/transaction-model)** - ACID guarantees - Isolation levels - Distributed transactions -7. **[Wire Protocol](../../specifications/data/wire-protocol)** +7. **[Wire Protocol](/docs/specifications/data/wire-protocol)** - Data serialization format - Network protocol - Compression and optimization @@ -90,16 +90,16 @@ The **Data Protocol (ObjectQL)** is the foundation of ObjectStack. It defines ho ### For Implementers Building a driver for ObjectStack? Start here: -- [Driver Interface](../../references/system/Driver) -- [Query Compiler](../../guides/custom-driver) -- [Test Suite](../../guides/driver-testing) +- [Driver Interface](/docs/references/system/Driver) +- [Query Compiler](/docs/guides/custom-driver) +- [Test Suite](/docs/guides/driver-testing) ### For Users Using ObjectStack to build applications? See: -- [Field Types Guide](../../guides/field-types) -- [Query Examples](../../guides/querying-data) -- [Business Logic](../../guides/workflows-validation) +- [Field Types Guide](/docs/guides/field-types) +- [Query Examples](/docs/guides/querying-data) +- [Business Logic](/docs/guides/workflows-validation) ## Design Principles @@ -144,6 +144,6 @@ const withSort = { ...withFilter, sort: [...] }; ## Related Documentation -- **[UI Protocol](../../specifications/ui/sdui-protocol)** - How to render data -- **[System Protocol](../../specifications/server/kernel-architecture)** - Runtime environment -- **[API Protocol](../../references/api/envelopes/BaseResponse)** - REST/GraphQL contracts +- **[UI Protocol](/docs/specifications/ui/sdui-protocol)** - How to render data +- **[System Protocol](/docs/specifications/server/kernel-architecture)** - Runtime environment +- **[API Protocol](/docs/references/api/envelopes/BaseResponse)** - REST/GraphQL contracts diff --git a/content/docs/specifications/data/schema-definition.mdx b/content/docs/specifications/data/schema-definition.mdx index df15d83..2246297 100644 --- a/content/docs/specifications/data/schema-definition.mdx +++ b/content/docs/specifications/data/schema-definition.mdx @@ -62,7 +62,7 @@ unique: false # Enforce Uniqueness ``` ### Core Field Types -See [Advanced Types](./advanced-types) for the full list. +See [Advanced Types](/docs/specifications/data/advanced-types) for the full list. * `text`, `textarea`, `html` * `number`, `currency`, `percent` * `date`, `datetime` diff --git a/content/docs/specifications/index.mdx b/content/docs/specifications/index.mdx index 9ca4bcd..dff4982 100644 --- a/content/docs/specifications/index.mdx +++ b/content/docs/specifications/index.mdx @@ -50,9 +50,9 @@ Building an ObjectStack implementation? - **Renderer Developers:** Build UI renderers (React, Vue, Flutter) Start with: -1. [System Protocol - Kernel Architecture](../specifications/server/kernel-architecture) -2. [Data Protocol - Architecture](../specifications/data/architecture) -3. [UI Protocol - SDUI Protocol](../specifications/ui/sdui-protocol) +1. [System Protocol - Kernel Architecture](/docs/specifications/server/kernel-architecture) +2. [Data Protocol - Architecture](/docs/specifications/data/architecture) +3. [UI Protocol - SDUI Protocol](/docs/specifications/ui/sdui-protocol) ### Platform Architects @@ -63,9 +63,9 @@ Evaluating ObjectStack for your organization? - **Solution Architects:** Design integration patterns Start with: -1. [Data Protocol - Architecture](../specifications/data/architecture) -2. [System Protocol - Permission Governance](../specifications/server/permission-governance) -3. [UI Protocol - Component Schema](../specifications/ui/component-schema) +1. [Data Protocol - Architecture](/docs/specifications/data/architecture) +2. [System Protocol - Permission Governance](/docs/specifications/server/permission-governance) +3. [UI Protocol - Component Schema](/docs/specifications/ui/component-schema) ### Advanced Users @@ -76,9 +76,9 @@ Building complex applications with ObjectStack? - **Integration Engineers:** Connect external systems Start with: -1. [Data Protocol - AST Structure](../specifications/data/ast-structure) -2. [System Protocol - Plugin Manifest](../specifications/server/plugin-manifest) -3. [UI Protocol - Action Triggers](../specifications/ui/action-triggers) +1. [Data Protocol - AST Structure](/docs/specifications/data/ast-structure) +2. [System Protocol - Plugin Manifest](/docs/specifications/server/plugin-manifest) +3. [UI Protocol - Action Triggers](/docs/specifications/ui/action-triggers) ## Specification Structure @@ -239,7 +239,7 @@ Want to propose changes or additions? ## Related Documentation -- **[Concepts](../concepts/architecture)** - High-level philosophy -- **[Guides](../guides/getting-started)** - Practical how-to guides -- **[References](../references/data/core/Object)** - Complete API documentation +- **[Concepts](/docs/concepts/architecture)** - High-level philosophy +- **[Guides](/docs/guides/getting-started)** - Practical how-to guides +- **[References](/docs/references/data/core/Object)** - Complete API documentation - **[Examples](https://github.com/objectstack-ai/spec/tree/main/examples)** - Reference implementations diff --git a/content/docs/specifications/server/index.mdx b/content/docs/specifications/server/index.mdx index 3c9e72d..e1b4c5d 100644 --- a/content/docs/specifications/server/index.mdx +++ b/content/docs/specifications/server/index.mdx @@ -45,31 +45,31 @@ The **System Protocol (ObjectOS)** defines the runtime environment for ObjectSta ### Core System -1. **[Kernel Architecture](../../specifications/server/kernel-architecture)** +1. **[Kernel Architecture](/docs/specifications/server/kernel-architecture)** - Kernel design and responsibilities - Component lifecycle - Event system - Dependency injection -2. **[Plugin Manifest](../../specifications/server/plugin-manifest)** +2. **[Plugin Manifest](/docs/specifications/server/plugin-manifest)** - Manifest structure (`objectstack.config.ts`) - Plugin metadata - Dependencies and versioning -3. **[Workflow Engine](../../specifications/server/workflow-engine)** +3. **[Workflow Engine](/docs/specifications/server/workflow-engine)** - Trigger types (before/after insert/update/delete) - Action execution - Error handling ### Security & Compliance -4. **[Permission Governance](../../specifications/server/permission-governance)** +4. **[Permission Governance](/docs/specifications/server/permission-governance)** - Object-level permissions - Field-level security - Row-level sharing - Territory management -5. **[Audit & Compliance](../../specifications/server/audit-compliance)** +5. **[Audit & Compliance](/docs/specifications/server/audit-compliance)** - Field history tracking - Login history - API usage logs @@ -77,12 +77,12 @@ The **System Protocol (ObjectOS)** defines the runtime environment for ObjectSta ### Integration -6. **[Automation Rules](../../specifications/server/automation-rules)** +6. **[Automation Rules](/docs/specifications/server/automation-rules)** - Field updates - Email alerts - Process automation -7. **[Integration & ETL](../../specifications/server/integration-etl)** +7. **[Integration & ETL](/docs/specifications/server/integration-etl)** - Webhook definitions - External API calls - Data transformation @@ -90,7 +90,7 @@ The **System Protocol (ObjectOS)** defines the runtime environment for ObjectSta ### API Layer -8. **[REST API](../../specifications/server/rest-api)** +8. **[REST API](/docs/specifications/server/rest-api)** - Endpoint structure - Request/Response format - Authentication @@ -364,19 +364,19 @@ onLoad(kernel: IKernel) { ### For Implementers Building a kernel implementation? Start here: -- [Kernel Interface](../../references/types/IKernel) -- [Plugin Development](../../guides/plugin-development) -- [Test Suite](../../guides/kernel-testing) +- [Kernel Interface](/docs/references/types/IKernel) +- [Plugin Development](/docs/guides/plugin-development) +- [Test Suite](/docs/guides/kernel-testing) ### For Users Deploying ObjectStack applications? See: -- [Installation Guide](../../guides/installation) -- [Configuration Reference](../../guides/configuration) -- [Deployment Guide](../../guides/deployment) +- [Installation Guide](/docs/guides/installation) +- [Configuration Reference](/docs/guides/configuration) +- [Deployment Guide](/docs/guides/deployment) ## Related Documentation -- **[Data Protocol](../../specifications/data/architecture)** - Data layer -- **[UI Protocol](../../specifications/ui/sdui-protocol)** - UI layer -- **[System Reference](../../references/system/config/Manifest)** - Configuration API +- **[Data Protocol](/docs/specifications/data/architecture)** - Data layer +- **[UI Protocol](/docs/specifications/ui/sdui-protocol)** - UI layer +- **[System Reference](/docs/references/system/config/Manifest)** - Configuration API diff --git a/content/docs/specifications/server/rest-api.cn.mdx b/content/docs/specifications/server/rest-api.cn.mdx index 5ffaa2e..c2bc9d3 100644 --- a/content/docs/specifications/server/rest-api.cn.mdx +++ b/content/docs/specifications/server/rest-api.cn.mdx @@ -97,4 +97,4 @@ ObjectStack 遵循 "Protocol First" 原则，提供了一套标准化的 RESTful 开发者可以通过 `ApiEndpointSchema` 定义自定义的 API 接口，这些接口通常挂载在 `/api/v1/custom` 下或自定义路径。 -详见 [Custom API Guide](../../specifications/server/custom-api). +详见 [Custom API Guide](/docs/specifications/server/custom-api). diff --git a/content/docs/specifications/server/rest-api.mdx b/content/docs/specifications/server/rest-api.mdx index ac450f0..ce5f5db 100644 --- a/content/docs/specifications/server/rest-api.mdx +++ b/content/docs/specifications/server/rest-api.mdx @@ -97,4 +97,4 @@ Based on the base path returned by `routes.metadata` (default is `/api/v1/meta`) Developers can define custom API interfaces via `ApiEndpointSchema`, which are typically mounted under `/api/v1/custom` or a custom path. -See [Custom API Guide](../../specifications/server/custom-api). +See [Custom API Guide](/docs/specifications/server/custom-api). diff --git a/content/docs/specifications/ui/index.mdx b/content/docs/specifications/ui/index.mdx index 0075d80..b5b2a0e 100644 --- a/content/docs/specifications/ui/index.mdx +++ b/content/docs/specifications/ui/index.mdx @@ -47,29 +47,29 @@ ObjectUI: Define JSON → Instant Update → No Rebuild Needed ### View Types -1. **[SDUI Protocol](../../specifications/ui/sdui-protocol)** +1. **[SDUI Protocol](/docs/specifications/ui/sdui-protocol)** - Server-Driven UI philosophy - JSON-based component definitions - Renderer architecture -2. **[View Protocol](../../specifications/ui/view-protocol)** +2. **[View Protocol](/docs/specifications/ui/view-protocol)** - ListView (Grid, Kanban, Calendar, Gantt) - FormView (Simple, Tabbed, Wizard) - DetailView (Record pages) -3. **[Component Schema](../../specifications/ui/component-schema)** +3. **[Component Schema](/docs/specifications/ui/component-schema)** - Button, Input, Select components - Custom component registration - Component props and events ### Layout & Styling -4. **[Layout System](../../specifications/ui/layout-system)** +4. **[Layout System](/docs/specifications/ui/layout-system)** - Grid-based layouts - Responsive breakpoints - Flexbox patterns -5. **[Action Triggers](../../specifications/ui/action-triggers)** +5. **[Action Triggers](/docs/specifications/ui/action-triggers)** - Button actions - URL navigation - Flow launches @@ -77,7 +77,7 @@ ObjectUI: Define JSON → Instant Update → No Rebuild Needed ### Analytics & Reporting -6. **[Report Template](../../specifications/ui/report-template)** +6. **[Report Template](/docs/specifications/ui/report-template)** - Report types (Tabular, Summary, Matrix) - Chart configurations - Dashboard widgets @@ -260,19 +260,19 @@ ObjectUI is a protocol. Multiple renderers can implement it: ### For Implementers Building a renderer for ObjectUI? Start here: -- [Renderer Interface](../../references/ui/Renderer) -- [Component Registry](../../guides/custom-components) -- [Test Suite](../../guides/renderer-testing) +- [Renderer Interface](/docs/references/ui/Renderer) +- [Component Registry](/docs/guides/custom-components) +- [Test Suite](/docs/guides/renderer-testing) ### For Users Using ObjectUI to build interfaces? See: -- [View Configuration Guide](../../guides/view-configuration) -- [Theming Guide](../../guides/theming) -- [Dashboard Examples](../../specifications/ui/dashboard) +- [View Configuration Guide](/docs/guides/view-configuration) +- [Theming Guide](/docs/guides/theming) +- [Dashboard Examples](/docs/specifications/ui/dashboard) ## Related Documentation -- **[Data Protocol](../../specifications/data/architecture)** - How to query data -- **[System Protocol](../../specifications/server/kernel-architecture)** - Runtime environment -- **[UI Reference](../../references/ui/views/View)** - Complete API reference +- **[Data Protocol](/docs/specifications/data/architecture)** - How to query data +- **[System Protocol](/docs/specifications/server/kernel-architecture)** - Runtime environment +- **[UI Reference](/docs/references/ui/views/View)** - Complete API reference diff --git a/content/docs/standards/api-design.mdx b/content/docs/standards/api-design.mdx index 487e9d4..ba0abb3 100644 --- a/content/docs/standards/api-design.mdx +++ b/content/docs/standards/api-design.mdx @@ -320,6 +320,6 @@ Response (200 OK): ## Related -- [Naming Conventions](./naming-conventions.md) -- [Error Handling](./error-handling.md) -- [REST API Specification](../../content/docs/specifications/server/rest-api.mdx) +- [Naming Conventions](/docs/standards/naming-conventions.md) +- [Error Handling](/docs/standards/error-handling.md) +- [REST API Specification](/docs/content/docs/specifications/server/rest-api.mdx) diff --git a/content/docs/standards/authentication.mdx b/content/docs/standards/authentication.mdx index 2ba972a..18f707e 100644 --- a/content/docs/standards/authentication.mdx +++ b/content/docs/standards/authentication.mdx @@ -534,7 +534,7 @@ const authConfig: AuthConfig = { ## Examples -See [examples/auth-better-examples.ts](../examples/auth-better-examples.ts) for comprehensive usage examples including: +See [examples/auth-better-examples.ts](/docs/examples/auth-better-examples.ts) for comprehensive usage examples including: - Basic email/password authentication - OAuth with Google and GitHub @@ -604,7 +604,7 @@ Following ObjectStack conventions: - [Better-Auth Documentation](https://better-auth.com) - [ObjectStack Documentation](https://objectstack.ai) -- [JSON Schema Reference](../packages/spec/json-schema/AuthConfig.json) +- [JSON Schema Reference](/docs/packages/spec/json-schema/AuthConfig.json) ## License diff --git a/content/docs/standards/error-handling.mdx b/content/docs/standards/error-handling.mdx index 166d979..0fd3213 100644 --- a/content/docs/standards/error-handling.mdx +++ b/content/docs/standards/error-handling.mdx @@ -180,5 +180,5 @@ if (process.env.NODE_ENV === 'development') { ## Related -- [API Design Principles](./api-design.md) -- [Security Best Practices](../guides/security/best-practices.md) +- [API Design Principles](/docs/standards/api-design.md) +- [Security Best Practices](/docs/guides/security/best-practices.md) diff --git a/content/docs/standards/index.mdx b/content/docs/standards/index.mdx index c6634c0..94ef5ea 100644 --- a/content/docs/standards/index.mdx +++ b/content/docs/standards/index.mdx @@ -9,25 +9,25 @@ This section documents the standards, conventions, and best practices for workin ## Protocol Standards -### [Naming Conventions](../standards/naming-conventions) +### [Naming Conventions](/docs/standards/naming-conventions) Learn the naming rules for schemas, fields, and identifiers: - Configuration keys use `camelCase` - Machine names use `snake_case` - Schema property naming patterns -### [API Design](../standards/api-design) +### [API Design](/docs/standards/api-design) API design principles and patterns for building consistent interfaces: - RESTful conventions - Request/Response envelopes - Error handling patterns -### [Error Handling](../standards/error-handling) +### [Error Handling](/docs/standards/error-handling) Consistent error handling strategies across the protocol: - Error types and codes - Error messages and localization - Recovery strategies -### [Authentication](../standards/authentication) +### [Authentication](/docs/standards/authentication) Authentication provider implementation standards: - OAuth, SAML, LDAP integration - Session management diff --git a/content/docs/standards/naming-conventions.mdx b/content/docs/standards/naming-conventions.mdx index a34fa3d..b35d580 100644 --- a/content/docs/standards/naming-conventions.mdx +++ b/content/docs/standards/naming-conventions.mdx @@ -78,4 +78,4 @@ const field = { | **Enum Values** | lowercase | `text`, `number`, `date` | | **Constants** | UPPER_SNAKE_CASE | `MAX_LENGTH`, `DEFAULT_TIMEOUT` | -For complete details and validation patterns, see [CONTRIBUTING.md](../../CONTRIBUTING.md#naming-conventions). +For complete details and validation patterns, see [CONTRIBUTING.md](/docs/CONTRIBUTING.md#naming-conventions). diff --git a/content/docs/troubleshooting.mdx b/content/docs/troubleshooting.mdx index b5ed4c8..e86fc0b 100644 --- a/content/docs/troubleshooting.mdx +++ b/content/docs/troubleshooting.mdx @@ -496,4 +496,4 @@ If you're still stuck after trying these solutions: - Minimal reproduction example 4. **Check the FAQ:** - - [Frequently Asked Questions](./faq) + - [Frequently Asked Questions](/docs/faq) diff --git a/content/docs/tutorials.mdx b/content/docs/tutorials.mdx index 5116d65..b4b31ed 100644 --- a/content/docs/tutorials.mdx +++ b/content/docs/tutorials.mdx @@ -111,12 +111,12 @@ Not sure where to start? Follow this recommended path: ### 1. Start with Quick Start -Complete [Build Your First App](./quick-start/build-first-app) (10 minutes) +Complete [Build Your First App](/docs/quick-start/build-first-app) (10 minutes) ### 2. Choose Your Path -- **Backend Focus:** [Field Types](./guides/field-types) → [Formulas](./references/data/core/Field) → [Workflows](./guides/workflows-validation) -- **Frontend Focus:** [Custom Views](./guides/view-configuration) → [Forms](./guides/view-configuration) → [Dashboards](./references/ui/analytics/Dashboard) -- **Full-Stack:** [CRM System](https://github.com/objectstack-ai/spec/tree/main/examples/crm) → [Multi-Tenancy](./guides/advanced/multi-tenancy) +- **Backend Focus:** [Field Types](/docs/guides/field-types) → [Formulas](/docs/references/data/core/Field) → [Workflows](/docs/guides/workflows-validation) +- **Frontend Focus:** [Custom Views](/docs/guides/view-configuration) → [Forms](/docs/guides/view-configuration) → [Dashboards](/docs/references/ui/analytics/Dashboard) +- **Full-Stack:** [CRM System](https://github.com/objectstack-ai/spec/tree/main/examples/crm) → [Multi-Tenancy](/docs/guides/advanced/multi-tenancy) ### 3. Build Your Own Apply what you've learned to build your own application! @@ -132,6 +132,6 @@ Check out community-contributed examples: ## Get Help Stuck on a tutorial? -- Check the [Troubleshooting Guide](./troubleshooting) +- Check the [Troubleshooting Guide](/docs/troubleshooting) - Ask in [GitHub Discussions](https://github.com/objectstack-ai/spec/discussions) -- Review the [FAQ](./faq) +- Review the [FAQ](/docs/faq) From 3b244c621152e7f779b5569265096177865c8c10 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 23 Jan 2026 01:49:49 +0000 Subject: [PATCH 06/11] Fix redundant /content/docs prefixes in links Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com> --- .../docs/specifications/architecture/data-layer.mdx | 8 ++++---- .../docs/specifications/architecture/system-layer.mdx | 8 ++++---- content/docs/specifications/architecture/ui-layer.mdx | 10 +++++----- content/docs/standards/api-design.mdx | 2 +- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/content/docs/specifications/architecture/data-layer.mdx b/content/docs/specifications/architecture/data-layer.mdx index 0da4eaf..82d3ba4 100644 --- a/content/docs/specifications/architecture/data-layer.mdx +++ b/content/docs/specifications/architecture/data-layer.mdx @@ -276,9 +276,9 @@ const indexes = [ ## Related Documentation -- [Field Types Guide](/docs/content/docs/guides/field-types.mdx) +- [Field Types Guide](/docs/guides/field-types.mdx) - [Query Protocol Guide](/docs/packages/spec/QUERY_PROTOCOL_GUIDE.md) -- [Schema Definition Specification](/docs/content/docs/specifications/data/schema-definition.mdx) -- [Driver Interface](/docs/content/docs/references/system/DriverInterface.mdx) +- [Schema Definition Specification](/docs/specifications/data/schema-definition.mdx) +- [Driver Interface](/docs/references/system/DriverInterface.mdx) -For complete API reference, see [Data Protocol References](/docs/content/docs/references/data/). +For complete API reference, see [Data Protocol References](/docs/references/data/). diff --git a/content/docs/specifications/architecture/system-layer.mdx b/content/docs/specifications/architecture/system-layer.mdx index 90e93ca..ca3ee17 100644 --- a/content/docs/specifications/architecture/system-layer.mdx +++ b/content/docs/specifications/architecture/system-layer.mdx @@ -446,9 +446,9 @@ const datasource = { ## Related Documentation -- [Plugin Architecture](/docs/content/docs/concepts/plugin-architecture.mdx) -- [Kernel Architecture](/docs/content/docs/specifications/server/kernel-architecture.mdx) +- [Plugin Architecture](/docs/concepts/plugin-architecture.mdx) +- [Kernel Architecture](/docs/specifications/server/kernel-architecture.mdx) - [Authentication Standard](/docs/specifications/AUTHENTICATION_STANDARD.md) -- [System Protocol References](/docs/content/docs/references/system/) +- [System Protocol References](/docs/references/system/) -For complete API reference, see [System Protocol References](/docs/content/docs/references/system/). +For complete API reference, see [System Protocol References](/docs/references/system/). diff --git a/content/docs/specifications/architecture/ui-layer.mdx b/content/docs/specifications/architecture/ui-layer.mdx index ea8e41b..a51ab9f 100644 --- a/content/docs/specifications/architecture/ui-layer.mdx +++ b/content/docs/specifications/architecture/ui-layer.mdx @@ -359,9 +359,9 @@ const page = { ## Related Documentation -- [View Configuration Guide](/docs/content/docs/guides/view-configuration.mdx) -- [SDUI Protocol Specification](/docs/content/docs/specifications/ui/sdui-protocol.mdx) -- [Component Schema](/docs/content/docs/specifications/ui/component-schema.mdx) -- [UI Protocol References](/docs/content/docs/references/ui/) +- [View Configuration Guide](/docs/guides/view-configuration.mdx) +- [SDUI Protocol Specification](/docs/specifications/ui/sdui-protocol.mdx) +- [Component Schema](/docs/specifications/ui/component-schema.mdx) +- [UI Protocol References](/docs/references/ui/) -For complete API reference, see [UI Protocol References](/docs/content/docs/references/ui/). +For complete API reference, see [UI Protocol References](/docs/references/ui/). diff --git a/content/docs/standards/api-design.mdx b/content/docs/standards/api-design.mdx index ba0abb3..0a0882e 100644 --- a/content/docs/standards/api-design.mdx +++ b/content/docs/standards/api-design.mdx @@ -322,4 +322,4 @@ Response (200 OK): - [Naming Conventions](/docs/standards/naming-conventions.md) - [Error Handling](/docs/standards/error-handling.md) -- [REST API Specification](/docs/content/docs/specifications/server/rest-api.mdx) +- [REST API Specification](/docs/specifications/server/rest-api.mdx) From 74ad59ee14744e9d60af614f3e6f2e734f3bdd97 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 23 Jan 2026 01:52:45 +0000 Subject: [PATCH 07/11] Add GitHub Action workflow for automated link checking Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com> --- .github/workflows/check-links.yml | 49 +++++++++++++++++++++++++++++++ .lycheeignore | 19 ++++++++++++ 2 files changed, 68 insertions(+) create mode 100644 .github/workflows/check-links.yml create mode 100644 .lycheeignore diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml new file mode 100644 index 0000000..af76bac --- /dev/null +++ b/.github/workflows/check-links.yml @@ -0,0 +1,49 @@ +name: Check Links + +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + link-checker: + name: Check Documentation Links + runs-on: ubuntu-latest + permissions: + contents: read + issues: write + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Check links with lychee + uses: lycheeverse/lychee-action@v2 + with: + # Scan all markdown and MDX files in content directory, plus root README + args: >- + --verbose + --no-progress + --exclude-file .lycheeignore + 'content/**/*.md' + 'content/**/*.mdx' + 'README.md' + # Fail the job if broken links are found + fail: true + + - name: Create Issue on Failure + if: failure() + uses: actions/github-script@v7 + with: + script: | + const output = process.env.LYCHEE_OUTPUT || 'Link check failed'; + github.rest.issues.create({ + owner: context.repo.owner, + repo: context.repo.repo, + title: '🔗 Broken links detected in documentation', + body: `Link checker found broken links in the documentation.\n\nPlease review the [workflow run](${context.payload.repository.html_url}/actions/runs/${context.runId}) for details.\n\n${output}`, + labels: ['documentation', 'bug'] + }); diff --git a/.lycheeignore b/.lycheeignore new file mode 100644 index 0000000..de1592c --- /dev/null +++ b/.lycheeignore @@ -0,0 +1,19 @@ +# Lychee Link Checker Ignore Rules +# This file contains patterns for links that should be ignored during link checking + +# Local development links +http://localhost* +http://127.0.0.1* + +# Example/placeholder links +https://example.com +https://example.org +http://example.com +http://example.org + +# Social media (防止反爬虫机制误报) +https://twitter.com* +https://x.com* + +# Common false positives +mailto:* From 457430d380ae62ab2ba582d92e7fe962d2a495f5 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 23 Jan 2026 01:53:50 +0000 Subject: [PATCH 08/11] Improve link checker workflow security and consistency Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com> --- .github/workflows/check-links.yml | 9 +++++---- .lycheeignore | 2 +- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml index af76bac..a9a9b12 100644 --- a/.github/workflows/check-links.yml +++ b/.github/workflows/check-links.yml @@ -21,7 +21,7 @@ jobs: uses: actions/checkout@v4 - name: Check links with lychee - uses: lycheeverse/lychee-action@v2 + uses: lycheeverse/lychee-action@2b973e86fc5181cd4fdfd5829efc58d4dd49a2c4 # v2.0.2 with: # Scan all markdown and MDX files in content directory, plus root README args: >- @@ -33,17 +33,18 @@ jobs: 'README.md' # Fail the job if broken links are found fail: true + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - name: Create Issue on Failure if: failure() - uses: actions/github-script@v7 + uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 with: script: | - const output = process.env.LYCHEE_OUTPUT || 'Link check failed'; github.rest.issues.create({ owner: context.repo.owner, repo: context.repo.repo, title: '🔗 Broken links detected in documentation', - body: `Link checker found broken links in the documentation.\n\nPlease review the [workflow run](${context.payload.repository.html_url}/actions/runs/${context.runId}) for details.\n\n${output}`, + body: `Link checker found broken links in the documentation.\n\nPlease review the [workflow run](${context.payload.repository.html_url}/actions/runs/${context.runId}) for details.`, labels: ['documentation', 'bug'] }); diff --git a/.lycheeignore b/.lycheeignore index de1592c..ccccf9c 100644 --- a/.lycheeignore +++ b/.lycheeignore @@ -11,7 +11,7 @@ https://example.org http://example.com http://example.org -# Social media (防止反爬虫机制误报) +# Social media (prevents anti-bot false positives) https://twitter.com* https://x.com* From 022196d1d2c7f89852474c46df277f5425cd2f41 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 23 Jan 2026 02:19:52 +0000 Subject: [PATCH 09/11] Fix link checker workflow - use stable action versions Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com> --- .github/workflows/check-links.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml index a9a9b12..585432a 100644 --- a/.github/workflows/check-links.yml +++ b/.github/workflows/check-links.yml @@ -21,7 +21,7 @@ jobs: uses: actions/checkout@v4 - name: Check links with lychee - uses: lycheeverse/lychee-action@2b973e86fc5181cd4fdfd5829efc58d4dd49a2c4 # v2.0.2 + uses: lycheeverse/lychee-action@v2 with: # Scan all markdown and MDX files in content directory, plus root README args: >- @@ -38,7 +38,7 @@ jobs: - name: Create Issue on Failure if: failure() - uses: actions/github-script@60a0d83039c74a4aee543508d2ffcb1c3799cdea # v7.0.1 + uses: actions/github-script@v7 with: script: | github.rest.issues.create({ From dfab7629b0613e6f07c15193b736ab945e8aa2d0 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 23 Jan 2026 02:42:49 +0000 Subject: [PATCH 10/11] Add lychee.toml config for internal link checking with path remapping Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com> --- .github/workflows/check-links.yml | 6 +-- lychee.toml | 63 +++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+), 4 deletions(-) create mode 100644 lychee.toml diff --git a/.github/workflows/check-links.yml b/.github/workflows/check-links.yml index 585432a..81b382b 100644 --- a/.github/workflows/check-links.yml +++ b/.github/workflows/check-links.yml @@ -23,11 +23,9 @@ jobs: - name: Check links with lychee uses: lycheeverse/lychee-action@v2 with: - # Scan all markdown and MDX files in content directory, plus root README + # Use configuration file for path remapping and settings args: >- - --verbose - --no-progress - --exclude-file .lycheeignore + --config lychee.toml 'content/**/*.md' 'content/**/*.mdx' 'README.md' diff --git a/lychee.toml b/lychee.toml new file mode 100644 index 0000000..0ec57cc --- /dev/null +++ b/lychee.toml @@ -0,0 +1,63 @@ +# Lychee Link Checker Configuration +# This configuration enables checking of internal Fumadocs links by remapping +# Next.js routes to actual file system paths + +# Maximum number of concurrent requests +max_concurrency = 10 + +# Accept status codes (2xx = success) +accept = [200, 204, 206, 301, 302, 307, 308, 429] + +# Timeout for requests (in seconds) +timeout = 30 + +# Retry failed requests +max_retries = 2 + +# Follow redirects +follow_redirects = true + +# Check anchors/fragments in links +include_fragments = false + +# Verbose output +verbose = true + +# Remap internal documentation links to actual file paths +# Maps /docs/(.+) routes to content/docs/$1.mdx or content/docs/$1.md +[[remap]] +pattern = "^/docs/(.+)$" +replace = "content/docs/$1.mdx" + +# Also check for .md files if .mdx doesn't exist +[[remap]] +pattern = "^/docs/(.+)$" +replace = "content/docs/$1.md" + +# Exclude patterns (loaded from .lycheeignore file) +exclude_path = [".lycheeignore"] + +# Additional exclude patterns for internal paths +exclude = [ + # Local development + "http://localhost*", + "http://127.0.0.1*", + + # Example/placeholder links + "https://example.com*", + "http://example.com*", + + # Social media (prevents anti-bot false positives) + "https://twitter.com*", + "https://x.com*", + + # Email links + "mailto:*" +] + +# Cache results to speed up subsequent runs +cache = true + +# Specify schemes to check (include file:// for local files) +# Leaving this unset allows all schemes including file:// +# scheme = ["https", "http", "file"] From eea0ba940e2a23766506830a651baf2272730754 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Fri, 23 Jan 2026 02:52:42 +0000 Subject: [PATCH 11/11] Fix lychee.toml TOML syntax error in remap configuration Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com> --- lychee.toml | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/lychee.toml b/lychee.toml index 0ec57cc..e08261c 100644 --- a/lychee.toml +++ b/lychee.toml @@ -24,15 +24,14 @@ include_fragments = false verbose = true # Remap internal documentation links to actual file paths -# Maps /docs/(.+) routes to content/docs/$1.mdx or content/docs/$1.md -[[remap]] -pattern = "^/docs/(.+)$" -replace = "content/docs/$1.mdx" - -# Also check for .md files if .mdx doesn't exist -[[remap]] -pattern = "^/docs/(.+)$" -replace = "content/docs/$1.md" +# Maps /docs/* routes to content/docs/*.mdx or content/docs/*.md files +# Lychee remap uses simple "pattern" = "replacement" syntax +remap = [ + # Primary remapping for .mdx files + "^/docs/(.*)$ content/docs/$1.mdx", + # Fallback for .md files + "^/docs/(.*)$ content/docs/$1.md" +] # Exclude patterns (loaded from .lycheeignore file) exclude_path = [".lycheeignore"]