Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions .github/workflows/check-links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
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:
# Use configuration file for path remapping and settings
args: >-
--config lychee.toml
'content/**/*.md'
'content/**/*.mdx'
'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
with:
script: |
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.`,
labels: ['documentation', 'bug']
});
Comment on lines +37 to +48
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The “Create Issue on Failure” step will run on pull_request builds as well, which can spam issues and often fails on forks due to restricted GITHUB_TOKEN permissions. Consider gating it to pushes on main only (e.g. if: failure() && github.event_name == 'push') or removing issues: write for PR runs.

Copilot uses AI. Check for mistakes.
19 changes: 19 additions & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
@@ -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 (prevents anti-bot false positives)
https://twitter.com*
https://x.com*

# Common false positives
mailto:*
12 changes: 6 additions & 6 deletions content/docs/guides/advanced/ai-integration-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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)
Comment on lines +795 to +796
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/docs/guides/packages/spec/src/ai and /docs/guides/examples are not valid docs routes in this repo (no corresponding pages under content/docs/guides/). Consider linking to the AI reference section under /docs/references/ai/ and to the GitHub /examples/ directory instead.

Suggested change
- [AI Protocol Reference](/docs/guides/packages/spec/src/ai)
- [Example Applications](/docs/guides/examples)
- [AI Protocol Reference](/docs/references/ai/)
- [Example Applications](https://github.com/objectstack/objectstack/tree/main/examples)

Copilot uses AI. Check for mistakes.
- [Discord Community](https://discord.gg/objectstack)

---
Expand Down
10 changes: 5 additions & 5 deletions content/docs/guides/advanced/ai-integration/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Comment on lines +169 to 175
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These example links point to /docs/examples/..., but there is no content/docs/examples/ directory (examples live under the repo’s /examples/). Use GitHub URLs (like other docs pages) or another existing docs route. Also /docs/guides/AI_INTEGRATION_GUIDE.md doesn’t exist; the guide file is content/docs/guides/advanced/ai-integration-guide.mdx (route /docs/guides/advanced/ai-integration-guide).

Copilot uses AI. Check for mistakes.
---

Expand Down
2 changes: 1 addition & 1 deletion content/docs/guides/advanced/security/best-practices.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/docs/AUTHENTICATION_STANDARD.md doesn’t exist in this repo/docs, so this link will 404 and fail link checking. Consider linking to the existing authentication docs page at /docs/standards/authentication (or another real docs route).

Suggested change
For detailed information, see [AUTHENTICATION_STANDARD.md](/docs/AUTHENTICATION_STANDARD.md)
For detailed information, see [Authentication Standard](/docs/standards/authentication)

Copilot uses AI. Check for mistakes.

---

Expand Down
2 changes: 1 addition & 1 deletion content/docs/guides/field-types.cn.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -737,7 +737,7 @@ created_at: Field.datetime({

## CRM 示例

参见 **[CRM 示例](/examples/crm)** 了解所有字段类型的实际使用:
参见 **[CRM 示例](https://github.com/objectstack-ai/spec/tree/main/examples/crm)** 了解所有字段类型的实际使用:

- **账户:** 自动编号、公式、货币、带颜色的选择
- **联系人:** 主从关系、公式(全名)、头像、电子邮件、电话
Expand Down
2 changes: 1 addition & 1 deletion content/docs/guides/field-types.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/docs/guides/getting-started.cn.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ views: {

现在你有了有效的元数据,你可以:

1. **探索示例**:查看 [CRM 示例](/examples/crm) 了解完整功能实现
1. **探索示例**:查看 [CRM 示例](https://github.com/objectstack-ai/spec/tree/main/examples/crm) 了解完整功能实现
2. **学习字段类型**:参见 [字段类型指南](/docs/guides/field-types) 了解所有 30+ 种字段类型
3. **构建 UI**:使用 ObjectStack 运行时的元数据来生成界面
4. **部署**:推送到 ObjectStack 内核用于生产环境
Expand Down
2 changes: 1 addition & 1 deletion content/docs/guides/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -275,7 +275,7 @@ views: {

Now that you have valid metadata, you can:

1. **Explore Examples**: Check out the [CRM Example](/examples/crm) for a full-featured implementation
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](/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
Expand Down
4 changes: 2 additions & 2 deletions content/docs/guides/migration/v0-to-v1.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Comment on lines +148 to +149
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These links point to /docs/CHANGELOG.md and /docs/CONTRIBUTING.md, but neither file exists under content/docs/, so they will be broken in the docs site and fail lychee remapping. Use GitHub blob links (repo root files) or add equivalent docs pages under content/docs/.

Suggested change
1. Check the [CHANGELOG.md](/docs/CHANGELOG.md)
2. Review [CONTRIBUTING.md](/docs/CONTRIBUTING.md)
1. Check the [CHANGELOG.md](https://github.com/objectstack/spec/blob/main/CHANGELOG.md)
2. Review [CONTRIBUTING.md](https://github.com/objectstack/spec/blob/main/CONTRIBUTING.md)

Copilot uses AI. Check for mistakes.
3. Open an issue on GitHub

---
Expand Down
2 changes: 1 addition & 1 deletion content/docs/guides/view-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -803,4 +803,4 @@ export const Opportunity = ObjectSchema.create({
- [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
- [CRM Example](https://github.com/objectstack-ai/spec/tree/main/examples/crm) - See all view types in action
2 changes: 1 addition & 1 deletion content/docs/guides/workflows-validation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -730,4 +730,4 @@ export const Opportunity = ObjectSchema.create({
- [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
- [CRM Example](https://github.com/objectstack-ai/spec/tree/main/examples/crm) - See validations and workflows in action
4 changes: 2 additions & 2 deletions content/docs/index.cn.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@ import { Book, Compass, FileText, Layers } from 'lucide-react';
- **[项目结构](/docs/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)** - 快速入门最小化示例

## "五位一体"架构

Expand Down
4 changes: 2 additions & 2 deletions content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ This documentation is the authoritative reference for the ObjectStack Protocol.
- **[Project Structure](/docs/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

Expand Down
8 changes: 4 additions & 4 deletions content/docs/quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,25 +13,25 @@ Welcome to ObjectStack! This quick start guide will help you get up and running
<Card
icon={<Zap />}
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"
/>
<Card
icon={<Code />}
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"
/>
<Card
icon={<Palette />}
title="I'm a frontend developer"
href="/docs/quick-start/frontend-developers"
href="./quick-start/frontend-developers"
description="Understand Views, Pages, and UI Components"
/>
<Card
icon={<Layers />}
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"
/>
</Cards>
Expand Down
10 changes: 5 additions & 5 deletions content/docs/specifications/architecture/data-layer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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/guides/field-types.mdx)
- [Query Protocol Guide](/docs/packages/spec/QUERY_PROTOCOL_GUIDE.md)
- [Schema Definition Specification](/docs/specifications/data/schema-definition.mdx)
- [Driver Interface](/docs/references/system/DriverInterface.mdx)
Comment on lines +279 to +282
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These /docs/... links include .mdx extensions, which will break the lychee /docs/* -> content/docs/*.mdx remap (it will look for field-types.mdx.mdx, etc.). Also, /docs/packages/spec/QUERY_PROTOCOL_GUIDE.md is not a docs page under content/docs/; link to the GitHub file or add a docs page for it.

Suggested change
- [Field Types Guide](/docs/guides/field-types.mdx)
- [Query Protocol Guide](/docs/packages/spec/QUERY_PROTOCOL_GUIDE.md)
- [Schema Definition Specification](/docs/specifications/data/schema-definition.mdx)
- [Driver Interface](/docs/references/system/DriverInterface.mdx)
- [Field Types Guide](/docs/guides/field-types)
- [Query Protocol Guide](https://github.com/objectstack/objectstack/blob/main/packages/spec/QUERY_PROTOCOL_GUIDE.md)
- [Schema Definition Specification](/docs/specifications/data/schema-definition)
- [Driver Interface](/docs/references/system/DriverInterface)

Copilot uses AI. Check for mistakes.

For complete API reference, see [Data Protocol References](../../content/docs/references/data/).
For complete API reference, see [Data Protocol References](/docs/references/data/).
10 changes: 5 additions & 5 deletions content/docs/specifications/architecture/system-layer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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/concepts/plugin-architecture.mdx)
- [Kernel Architecture](/docs/specifications/server/kernel-architecture.mdx)
- [Authentication Standard](/docs/specifications/AUTHENTICATION_STANDARD.md)
Comment on lines +449 to +451
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section mixes .mdx-suffixed /docs/... links and a link to /docs/specifications/AUTHENTICATION_STANDARD.md, but there is no AUTHENTICATION_STANDARD.md in the repo/docs, so it will 404. Use extensionless routes and point the authentication link to an existing page (e.g. /docs/standards/authentication).

Suggested change
- [Plugin Architecture](/docs/concepts/plugin-architecture.mdx)
- [Kernel Architecture](/docs/specifications/server/kernel-architecture.mdx)
- [Authentication Standard](/docs/specifications/AUTHENTICATION_STANDARD.md)
- [Plugin Architecture](/docs/concepts/plugin-architecture)
- [Kernel Architecture](/docs/specifications/server/kernel-architecture)
- [Authentication Standard](/docs/standards/authentication)

Copilot uses AI. Check for mistakes.
- [System Protocol References](/docs/references/system/)

For complete API reference, see [System Protocol References](../../content/docs/references/system/).
For complete API reference, see [System Protocol References](/docs/references/system/).
10 changes: 5 additions & 5 deletions content/docs/specifications/architecture/ui-layer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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/guides/view-configuration.mdx)
- [SDUI Protocol Specification](/docs/specifications/ui/sdui-protocol.mdx)
- [Component Schema](/docs/specifications/ui/component-schema.mdx)
Comment on lines +362 to +364
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These internal doc links include .mdx extensions (e.g. /docs/guides/view-configuration.mdx), but the rest of the site uses extensionless routes and lychee’s remap expects extensionless /docs/* paths. Please switch these to extensionless routes (e.g. /docs/guides/view-configuration, /docs/specifications/ui/sdui-protocol, /docs/specifications/ui/component-schema).

Suggested change
- [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)
- [View Configuration Guide](/docs/guides/view-configuration)
- [SDUI Protocol Specification](/docs/specifications/ui/sdui-protocol)
- [Component Schema](/docs/specifications/ui/component-schema)

Copilot uses AI. Check for mistakes.
- [UI Protocol References](/docs/references/ui/)

For complete API reference, see [UI Protocol References](../../content/docs/references/ui/).
For complete API reference, see [UI Protocol References](/docs/references/ui/).
6 changes: 3 additions & 3 deletions content/docs/specifications/data/architecture.cn.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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 交换这些结构。 |

## 设计约束

Expand Down
6 changes: 3 additions & 3 deletions content/docs/specifications/data/architecture.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion content/docs/specifications/data/schema-definition.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion content/docs/specifications/ui/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -269,7 +269,7 @@ Building a renderer for ObjectUI? Start here:
Using ObjectUI to build interfaces? See:
- [View Configuration Guide](/docs/guides/view-configuration)
- [Theming Guide](/docs/guides/theming)
- [Dashboard Examples](/docs/tutorials/dashboards)
- [Dashboard Examples](/docs/specifications/ui/dashboard)
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/docs/specifications/ui/dashboard does not exist under content/docs/specifications/ui/ (no dashboard.mdx), so this link will 404. Consider linking to the existing dashboard reference (/docs/references/ui/analytics/Dashboard) or adding the missing dashboard spec page.

Suggested change
- [Dashboard Examples](/docs/specifications/ui/dashboard)
- [Dashboard Examples](/docs/references/ui/analytics/Dashboard)

Copilot uses AI. Check for mistakes.

## Related Documentation

Expand Down
6 changes: 3 additions & 3 deletions content/docs/standards/api-design.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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/specifications/server/rest-api.mdx)
Comment on lines +323 to +325
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These /docs/... links include .md/.mdx extensions, which don’t match the extensionless doc routes used elsewhere (e.g. content/docs/standards/index.mdx) and will also break the lychee remap (it will look for *.md.mdx). Please switch these to extensionless routes like /docs/standards/naming-conventions, /docs/standards/error-handling, and /docs/specifications/server/rest-api.

Suggested change
- [Naming Conventions](/docs/standards/naming-conventions.md)
- [Error Handling](/docs/standards/error-handling.md)
- [REST API Specification](/docs/specifications/server/rest-api.mdx)
- [Naming Conventions](/docs/standards/naming-conventions)
- [Error Handling](/docs/standards/error-handling)
- [REST API Specification](/docs/specifications/server/rest-api)

Copilot uses AI. Check for mistakes.
4 changes: 2 additions & 2 deletions content/docs/standards/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This points to /docs/examples/auth-better-examples.ts, but there is no such file under content/docs/ or the repo’s examples/ directory, so the link is broken. Either add the referenced example file or link to an existing example/resource.

Suggested change
See [examples/auth-better-examples.ts](/docs/examples/auth-better-examples.ts) for comprehensive usage examples including:
See the [Better Auth reference implementation examples](https://better-auth.com/docs) for comprehensive usage examples including:

Copilot uses AI. Check for mistakes.

- Basic email/password authentication
- OAuth with Google and GitHub
Expand Down Expand Up @@ -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)
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/docs/packages/spec/json-schema/AuthConfig.json is not a docs page under content/docs/, so it will 404 and fail lychee remapping. Consider linking to the existing docs reference page /docs/references/system/AuthConfig or to the GitHub file packages/spec/json-schema/AuthConfig.json.

Suggested change
- [JSON Schema Reference](/docs/packages/spec/json-schema/AuthConfig.json)
- [JSON Schema Reference](/docs/references/system/AuthConfig)

Copilot uses AI. Check for mistakes.

## License

Expand Down
4 changes: 2 additions & 2 deletions content/docs/standards/error-handling.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Comment on lines +183 to +184
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These /docs/... links include .md extensions, which don’t match the Fumadocs route style used elsewhere (e.g. /docs/standards/api-design) and will also break the lychee /docs/* -> content/docs/*.mdx remap (it will look for api-design.md.mdx). Use extensionless /docs/standards/api-design and update the security link to the actual page at /docs/guides/advanced/security/best-practices.

Suggested change
- [API Design Principles](/docs/standards/api-design.md)
- [Security Best Practices](/docs/guides/security/best-practices.md)
- [API Design Principles](/docs/standards/api-design)
- [Security Best Practices](/docs/guides/advanced/security/best-practices)

Copilot uses AI. Check for mistakes.
2 changes: 1 addition & 1 deletion content/docs/standards/naming-conventions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Copy link

Copilot AI Jan 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/docs/CONTRIBUTING.md#naming-conventions does not correspond to any page under content/docs/ (there is no content/docs/CONTRIBUTING.md(x)), so this link will 404 and will fail lychee’s /docs/* -> content/docs/* remap. Consider linking to the GitHub file (blob URL) or creating a docs page under content/docs/ for CONTRIBUTING.

Suggested change
For complete details and validation patterns, see [CONTRIBUTING.md](/docs/CONTRIBUTING.md#naming-conventions).
For complete details and validation patterns, see [CONTRIBUTING.md](/CONTRIBUTING.md#naming-conventions).

Copilot uses AI. Check for mistakes.
Loading
Loading