Skip to content

Commit f60234c

Browse files
Copilothotlong
andcommitted
Revert incorrect link changes - fumadocs requires /docs/ prefix
The baseUrl: '/docs' config means docs are served at /docs routes, so internal links MUST include /docs/ prefix to match URL structure. My original understanding was incorrect. - Reverted all documentation link changes to original state - Updated validation script to correctly handle /docs/ prefix - Removed fix-links.sh script (no longer needed) - Updated CONTRIBUTING.md with correct link conventions - Updated scripts/README.md with correct examples Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 591dc00 commit f60234c

24 files changed

Lines changed: 159 additions & 209 deletions

CONTRIBUTING.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -426,30 +426,30 @@ pnpm site:build
426426
#### ✅ Correct Link Patterns
427427

428428
```markdown
429-
<!-- Correct - links start with / but do NOT include /docs/ -->
430-
[Quick Start](/guide/quick-start)
431-
[Components](/components)
432-
[API Reference](/reference/api/core)
433-
[Protocol Specs](/reference/protocol/overview)
434-
[Architecture](/architecture/component)
429+
<!-- Correct - internal documentation links MUST include /docs/ prefix -->
430+
[Quick Start](/docs/guide/quick-start)
431+
[Components](/docs/components)
432+
[API Reference](/docs/reference/api/core)
433+
[Protocol Specs](/docs/reference/protocol/overview)
434+
[Architecture](/docs/architecture/component)
435435
```
436436

437437
#### ❌ Incorrect Link Patterns
438438

439439
```markdown
440-
<!-- Wrong - includes /docs/ prefix -->
441-
[Quick Start](/docs/guide/quick-start) <!---->
442-
[Components](/docs/components) <!---->
440+
<!-- Wrong - missing /docs/ prefix -->
441+
[Quick Start](/guide/quick-start) <!-- Should be /docs/guide/quick-start -->
442+
[Components](/components) <!-- Should be /docs/components -->
443443

444444
<!-- Wrong - incorrect paths -->
445-
[API Reference](/api/core) <!-- ❌ Should be /reference/api/core -->
446-
[Spec](/spec/component) <!-- ❌ Should be /architecture/component -->
447-
[Protocol](/protocol/form) <!-- ❌ Should be /reference/protocol/form -->
445+
[API Reference](/api/core) <!-- ❌ Should be /docs/reference/api/core -->
446+
[Spec](/spec/component) <!-- ❌ Should be /docs/architecture/component -->
447+
[Protocol](/protocol/form) <!-- ❌ Should be /docs/reference/protocol/form -->
448448
```
449449

450450
#### Why?
451451

452-
Fumadocs already configures the base URL as `/docs` in the routing system. Adding `/docs/` to your links creates invalid paths like `/docs/docs/guide/quick-start`.
452+
Fumadocs is configured with `baseUrl: '/docs'`, which means all documentation pages are served under the `/docs` route. Internal links must include the `/docs/` prefix to match the actual URL structure where the pages are accessible.
453453

454454
#### Validating Links
455455

@@ -461,8 +461,8 @@ pnpm validate:links
461461
```
462462

463463
This will check:
464-
- Links don't contain `/docs/` prefix
465464
- Links point to existing files and routes
465+
- Links use correct path structure
466466
- Suggestions for fixing common issues
467467

468468
The validation runs automatically on PRs that modify documentation files.

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ Use relative links for internal documentation:
213213

214214
```markdown
215215
See [Schema Rendering](./schema-rendering.md) for details.
216-
See [Protocol Overview](/reference/protocol/overview) for specs.
216+
See [Protocol Overview](/protocol/overview) for specs.
217217
```
218218

219219
### Front Matter

docs/architecture/base-components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This specification defines the metadata structure for ObjectQL's built-in platfo
1414
- Enable marketplace distribution
1515

1616
**Scope:** This document covers the complete metadata specification for all platform base components, including data display, data entry, layout, navigation, and visualization components.
17-
For the low-level UI component library (Button, Input, Dialog, etc.), please refer to the [Component Library Reference](/architecture/component-library).
17+
For the low-level UI component library (Button, Input, Dialog, etc.), please refer to the [Component Library Reference](component-library.md).
1818

1919
## 2. Base Component Categories
2020

docs/components/index.md

Lines changed: 46 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,28 @@ ObjectUI provides a comprehensive set of components built on React, Tailwind CSS
1111

1212
Browse components by category to find what you need:
1313

14-
### [Basic Components](/components/basic/text)
14+
### [Basic Components](/docs/components/basic/text)
1515
Essential building blocks: Text, Icon, Image, Separator, HTML
1616

17-
### [Form Components](/components/form/button)
17+
### [Form Components](/docs/components/form/button)
1818
Interactive inputs: Button, Input, Select, Checkbox, Switch, Textarea, Slider
1919

20-
### [Layout Components](/components/layout/container)
20+
### [Layout Components](/docs/components/layout/container)
2121
Structure your UI: Container, Card, Grid, Flex, Stack, Tabs
2222

23-
### [Data Display](/components/data-display/badge)
23+
### [Data Display](/docs/components/data-display/badge)
2424
Show information: Badge, Avatar, Alert, List
2525

26-
### [Feedback Components](/components/feedback/loading)
26+
### [Feedback Components](/docs/components/feedback/loading)
2727
User feedback: Loading, Progress, Skeleton
2828

29-
### [Overlay Components](/components/overlay/dialog)
29+
### [Overlay Components](/docs/components/overlay/dialog)
3030
Floating elements: Dialog, Drawer, Tooltip, Popover
3131

32-
### [Disclosure Components](/components/disclosure/accordion)
32+
### [Disclosure Components](/docs/components/disclosure/accordion)
3333
Show/hide content: Accordion, Collapsible
3434

35-
### [Complex Components](/components/complex/table)
35+
### [Complex Components](/docs/components/complex/table)
3636
Advanced patterns: Table (with sorting, filtering, pagination)
3737

3838
## Component Categories
@@ -41,73 +41,73 @@ Advanced patterns: Table (with sorting, filtering, pagination)
4141

4242
The foundation of your UI. These are simple, single-purpose components:
4343

44-
- **[Text](/components/basic/text)** - Display text with typography control
45-
- **[Icon](/components/basic/icon)** - Render icons from Lucide React
46-
- **[Image](/components/basic/image)** - Display images with lazy loading
47-
- **[Separator](/components/basic/separator)** - Visual divider between content
48-
- **[HTML](/components/basic/html)** - Render raw HTML content
44+
- **[Text](/docs/components/basic/text)** - Display text with typography control
45+
- **[Icon](/docs/components/basic/icon)** - Render icons from Lucide React
46+
- **[Image](/docs/components/basic/image)** - Display images with lazy loading
47+
- **[Separator](/docs/components/basic/separator)** - Visual divider between content
48+
- **[HTML](/docs/components/basic/html)** - Render raw HTML content
4949

5050
### Form Components
5151

5252
Interactive elements for user input:
5353

54-
- **[Button](/components/form/button)** - Trigger actions with multiple variants
55-
- **[Input](/components/form/input)** - Text input with validation
56-
- **[Select](/components/form/select)** - Dropdown selection
57-
- **[Checkbox](/components/form/checkbox)** - Boolean selection
58-
- **[Switch](/components/form/switch)** - Toggle switch
59-
- **[Textarea](/components/form/textarea)** - Multi-line text input
60-
- **[Slider](/components/form/slider)** - Numeric range selection
54+
- **[Button](/docs/components/form/button)** - Trigger actions with multiple variants
55+
- **[Input](/docs/components/form/input)** - Text input with validation
56+
- **[Select](/docs/components/form/select)** - Dropdown selection
57+
- **[Checkbox](/docs/components/form/checkbox)** - Boolean selection
58+
- **[Switch](/docs/components/form/switch)** - Toggle switch
59+
- **[Textarea](/docs/components/form/textarea)** - Multi-line text input
60+
- **[Slider](/docs/components/form/slider)** - Numeric range selection
6161

6262
### Layout Components
6363

6464
Structure and organize your interface:
6565

66-
- **[Container](/components/layout/container)** - Responsive container with max-width
67-
- **[Card](/components/layout/card)** - Content card with header and footer
68-
- **[Grid](/components/layout/grid)** - CSS Grid layout
69-
- **[Flex](/components/layout/flex)** - Flexbox layout
70-
- **[Stack](/components/layout/stack)** - Vertical or horizontal stack
71-
- **[Tabs](/components/layout/tabs)** - Tabbed interface
66+
- **[Container](/docs/components/layout/container)** - Responsive container with max-width
67+
- **[Card](/docs/components/layout/card)** - Content card with header and footer
68+
- **[Grid](/docs/components/layout/grid)** - CSS Grid layout
69+
- **[Flex](/docs/components/layout/flex)** - Flexbox layout
70+
- **[Stack](/docs/components/layout/stack)** - Vertical or horizontal stack
71+
- **[Tabs](/docs/components/layout/tabs)** - Tabbed interface
7272

7373
### Data Display
7474

7575
Present data to users:
7676

77-
- **[Badge](/components/data-display/badge)** - Small status indicators
78-
- **[Avatar](/components/data-display/avatar)** - User profile images
79-
- **[Alert](/components/data-display/alert)** - Contextual messages
80-
- **[List](/components/data-display/list)** - Ordered or unordered lists
77+
- **[Badge](/docs/components/data-display/badge)** - Small status indicators
78+
- **[Avatar](/docs/components/data-display/avatar)** - User profile images
79+
- **[Alert](/docs/components/data-display/alert)** - Contextual messages
80+
- **[List](/docs/components/data-display/list)** - Ordered or unordered lists
8181

8282
### Feedback Components
8383

8484
Provide visual feedback:
8585

86-
- **[Loading](/components/feedback/loading)** - Loading spinner
87-
- **[Progress](/components/feedback/progress)** - Progress bar
88-
- **[Skeleton](/components/feedback/skeleton)** - Loading placeholder
86+
- **[Loading](/docs/components/feedback/loading)** - Loading spinner
87+
- **[Progress](/docs/components/feedback/progress)** - Progress bar
88+
- **[Skeleton](/docs/components/feedback/skeleton)** - Loading placeholder
8989

9090
### Overlay Components
9191

9292
Floating UI elements:
9393

94-
- **[Dialog](/components/overlay/dialog)** - Modal dialog
95-
- **[Drawer](/components/overlay/drawer)** - Slide-out drawer
96-
- **[Tooltip](/components/overlay/tooltip)** - Hover tooltips
97-
- **[Popover](/components/overlay/popover)** - Floating popover
94+
- **[Dialog](/docs/components/overlay/dialog)** - Modal dialog
95+
- **[Drawer](/docs/components/overlay/drawer)** - Slide-out drawer
96+
- **[Tooltip](/docs/components/overlay/tooltip)** - Hover tooltips
97+
- **[Popover](/docs/components/overlay/popover)** - Floating popover
9898

9999
### Disclosure Components
100100

101101
Expandable content:
102102

103-
- **[Accordion](/components/disclosure/accordion)** - Expandable sections
104-
- **[Collapsible](/components/disclosure/collapsible)** - Toggle content visibility
103+
- **[Accordion](/docs/components/disclosure/accordion)** - Expandable sections
104+
- **[Collapsible](/docs/components/disclosure/collapsible)** - Toggle content visibility
105105

106106
### Complex Components
107107

108108
Advanced, feature-rich components:
109109

110-
- **[Table](/components/complex/table)** - Data table with sorting, filtering, and pagination
110+
- **[Table](/docs/components/complex/table)** - Data table with sorting, filtering, and pagination
111111

112112
## Usage Pattern
113113

@@ -175,15 +175,15 @@ All ObjectUI components share these characteristics:
175175

176176
## Next Steps
177177

178-
- **[Quick Start Guide](/guide/quick-start)** - Build your first ObjectUI app
179-
- **[Schema Rendering](/concepts/schema-rendering)** - Learn how the engine works
180-
- **[Component Registry](/concepts/component-registry)** - Register custom components
181-
- **[Expressions](/concepts/expressions)** - Dynamic values with expressions
178+
- **[Quick Start Guide](/docs/guide/quick-start)** - Build your first ObjectUI app
179+
- **[Schema Rendering](/docs/concepts/schema-rendering)** - Learn how the engine works
180+
- **[Component Registry](/docs/concepts/component-registry)** - Register custom components
181+
- **[Expressions](/docs/concepts/expressions)** - Dynamic values with expressions
182182

183183
## Need Help?
184184

185185
Can't find what you're looking for? Check out:
186186

187-
- [Concepts](/concepts) - Core concepts and architecture
188-
- [Advanced](/reference) - API documentation and protocol specs
187+
- [Concepts](/docs/concepts) - Core concepts and architecture
188+
- [Advanced](/docs/reference) - API documentation and protocol specs
189189
- [GitHub](https://github.com/objectstack-ai/objectui) - Report issues or contribute

docs/concepts/component-registry.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -459,10 +459,10 @@ export { RatingComponent }
459459

460460
- [Expression System](./expressions.md) - Learn about dynamic expressions
461461
- [Schema Rendering](./schema-rendering.md) - Understand the rendering engine
462-
- [Creating Custom Components](/architecture/component-package) - Deep dive into component creation
462+
- [Creating Custom Components](/spec/component-package.md) - Deep dive into component creation
463463

464464
## Related Documentation
465465

466-
- [Core API](/reference/api/core) - Component registry API
467-
- [React API](/reference/api/react) - React integration
468-
- [Component Specification](/architecture/component) - Component metadata spec
466+
- [Core API](/api/core) - Component registry API
467+
- [React API](/api/react) - React integration
468+
- [Component Specification](/spec/component.md) - Component metadata spec

docs/concepts/expressions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -636,10 +636,10 @@ const data: UserData = { /* ... */ }
636636

637637
- [Schema Rendering](./schema-rendering.md) - Learn the rendering engine
638638
- [Component Registry](./component-registry.md) - Understand components
639-
- [Protocol Overview](/reference/protocol/overview) - Explore schema specifications
639+
- [Protocol Overview](/protocol/overview) - Explore schema specifications
640640

641641
## Related Documentation
642642

643-
- [Core API](/reference/api/core) - Expression evaluator API
644-
- [Form Protocol](/reference/protocol/form) - Form-specific expressions
645-
- [View Protocol](/reference/protocol/view) - Data view expressions
643+
- [Core API](/api/core) - Expression evaluator API
644+
- [Form Protocol](/protocol/form) - Form-specific expressions
645+
- [View Protocol](/protocol/view) - Data view expressions

docs/concepts/plugins.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -373,7 +373,7 @@ export function registerComponents() {
373373
- [Component Registry](./component-registry.md) - Understanding the registry
374374
- [Schema Rendering](./schema-rendering.md) - How schemas become UI
375375
- [Lazy-Loaded Plugins Architecture](./lazy-loading.md) - Deep dive
376-
- [Creating Components](/architecture/component-package) - Component development
376+
- [Creating Components](/spec/component-package.md) - Component development
377377
378378
## Next Steps
379379

docs/concepts/schema-rendering.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -411,11 +411,11 @@ Always type your schemas for better IDE support and fewer runtime errors.
411411

412412
- [Component Registry](./component-registry.md) - Learn about component registration
413413
- [Expression System](./expressions.md) - Master expressions
414-
- [Protocol Overview](/reference/protocol/overview) - Explore all available schemas
414+
- [Protocol Overview](/protocol/overview) - Explore all available schemas
415415

416416
## Related Documentation
417417

418-
- [Rendering Specification](/architecture/rendering-specification) - Technical specification
419-
- [Architecture](/architecture) - System architecture
420-
- [Core API](/reference/api/core) - Core package API reference
421-
- [React API](/reference/api/react) - React package API reference
418+
- [Schema Specification](/spec/schema-rendering) - Technical specification
419+
- [Architecture](/spec/architecture) - System architecture
420+
- [Core API](/api/core) - Core package API reference
421+
- [React API](/api/react) - React package API reference

docs/guide/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -183,9 +183,9 @@ Object UI is perfect for:
183183

184184
Ready to get started?
185185

186-
- [Quick Start](/guide/quick-start) - Build your first Object UI app
187-
- [Installation](/guide/installation) - Setup instructions
188-
- [Schema Rendering](/concepts/schema-rendering) - Learn the core concepts
186+
- [Quick Start](/docs/guide/quick-start) - Build your first Object UI app
187+
- [Installation](/docs/guide/installation) - Setup instructions
188+
- [Schema Rendering](/docs/concepts/schema-rendering) - Learn the core concepts
189189

190190
## Getting Help
191191

docs/guide/studio.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -189,10 +189,10 @@ It is **not** designed for:
189189

190190
## What's Next?
191191

192-
- [Read the full guide](/guide)
193-
- [Explore the API reference](/reference/api/react)
194-
- [Check out component specifications](/reference/protocol/overview)
195-
- [View the project roadmap](https://github.com/objectstack-ai/objectui)
192+
- [Read the full guide](/docs/guide/introduction)
193+
- [Explore the API reference](/docs/api/react)
194+
- [Check out component specifications](/docs/protocol/overview)
195+
- [View the project roadmap](/ROADMAP)
196196

197197
## Feedback
198198

0 commit comments

Comments
 (0)