Fix remaining broken links and add lychee.toml configuration

Addressed code review feedback and @hotlong's request:

1. Fixed API reference link in plugin-markdown.mdx:
   - Changed /docs/reference/api → /docs/reference/api/core

2. Fixed all remaining links in docs/index.md to include /docs/ prefix:
   - CLI Guide, Installation Guide
   - All "Getting Started" section links
   - All "Components" section links
   - All "Core Concepts", "Plugins", "Reference" links
   - All "Architecture", "Ecosystem", "Support" links
   - All "Community" section links
   - All CTA buttons at the end

3. Created lychee.toml configuration:
   - Maps Next.js routes (/docs/*) to filesystem paths (docs/*.mdx)
   - Handles both .md and .mdx extensions
   - Handles index files (/docs/components/ → docs/components/index.mdx)
   - Configures excludes for localhost, example.com, social media

4. Updated check-links.yml workflow:
   - Now loads lychee.toml configuration
   - Scans docs/**/*.{md,mdx} and README.md
   - Removed content/**/*.{md,mdx} (doesn't exist at root)

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Author: Copilot

.github/workflows/check-links.yml

@@ -16,14 +16,11 @@ jobs:
       - name: Check links with Lychee
         uses: lycheeverse/lychee-action@v1
         with:
-          # Scan all markdown files in content directories and README
+          # Scan all markdown files in docs directory and README
           args: |
             --verbose
             --no-progress
-            --exclude-path .git
-            --exclude-path node_modules
-            'content/**/*.md'
-            'content/**/*.mdx'
+            --config lychee.toml
             'docs/**/*.md'
             'docs/**/*.mdx'
             'README.md'

docs/index.md

@@ -145,7 +145,7 @@ cd my-admin
 objectui dev
 ```
 
-[**📖 CLI Guide →**](/guide/cli/getting-started)
+[**📖 CLI Guide →**](/docs/guide/cli/getting-started)
 
 ### Option B: React Library
 
@@ -173,66 +173,66 @@ function App() {
 }
 ```
 
-[**📖 Installation Guide →**](/guide/installation)
+[**📖 Installation Guide →**](/docs/guide/installation)
 
 ---
 
 ## Documentation Structure
 
 ### 📘 Getting Started
 Start here if you're new to ObjectUI
-- [Quick Start](/guide/quick-start)
-- [Installation](/guide/installation)
-- [Showcase](/guide/showcase)
+- [Quick Start](/docs/guide/quick-start)
+- [Installation](/docs/guide/installation)
+- [Showcase](/docs/guide/showcase)
 
 ### 🧩 Components
 Browse all available components
-- [Component Gallery](/components/)
-- [Form Components](/components/form/)
-- [Layout Components](/components/layout/)
+- [Component Gallery](/docs/components/)
+- [Form Components](/docs/components/form/)
+- [Layout Components](/docs/components/layout/)
 
 ### 💡 Core Concepts
 Understand how ObjectUI works
-- [Schema Rendering](/concepts/schema-rendering)
-- [Expressions](/concepts/expressions)
-- [Data Sources](/concepts/data-source)
+- [Schema Rendering](/docs/concepts/schema-rendering)
+- [Expressions](/docs/concepts/expressions)
+- [Data Sources](/docs/concepts/data-source)
 
 ### 🔌 Plugins
 Extend ObjectUI with plugins
-- [Plugin System](/concepts/plugins)
-- [Charts Plugin](/plugins/plugin-charts)
-- [Kanban Plugin](/plugins/plugin-kanban)
+- [Plugin System](/docs/concepts/plugins)
+- [Charts Plugin](/docs/plugins/plugin-charts)
+- [Kanban Plugin](/docs/plugins/plugin-kanban)
 
 ### 📚 Reference
 Detailed API documentation
-- [Core API](/reference/api/core)
-- [React API](/reference/api/react)
-- [Protocol Specifications](/reference/protocol/overview)
+- [Core API](/docs/reference/api/core)
+- [React API](/docs/reference/api/react)
+- [Protocol Specifications](/docs/reference/protocol/overview)
 
 ### 🏗️ Architecture
 For contributors and advanced users
-- [System Architecture](/architecture/architecture)
-- [Project Structure](/architecture/project-structure)
-- [Component Specs](/architecture/component)
+- [System Architecture](/docs/architecture/architecture)
+- [Project Structure](/docs/architecture/project-structure)
+- [Component Specs](/docs/architecture/component)
 
 ### 🌐 Ecosystem
 Integration and deployment
-- [ObjectQL Integration](/ecosystem/objectql)
-- [API Integration](/ecosystem/api)
-- [Deployment Guide](/ecosystem/deployment/showcase-deployment)
+- [ObjectQL Integration](/docs/ecosystem/objectql)
+- [API Integration](/docs/ecosystem/api)
+- [Deployment Guide](/docs/ecosystem/deployment/showcase-deployment)
 
 ### 🆘 Support
 Get help when you need it
-- [FAQ](/faq) - Common questions
-- [Troubleshooting](/troubleshooting) - Problem solving
-- [Security](/security) - Security best practices
-- [Migration](/migration/from-objectstack) - Migration guides
+- [FAQ](/docs/faq) - Common questions
+- [Troubleshooting](/docs/troubleshooting) - Problem solving
+- [Security](/docs/security) - Security best practices
+- [Migration](/docs/migration/from-objectstack) - Migration guides
 
 ### 🤝 Community
 Contribute and collaborate
-- [Contributing](/community/contributing)
-- [Roadmap](/community/roadmap)
-- [Best Practices](/community/best-practices)
+- [Contributing](/docs/community/contributing)
+- [Roadmap](/docs/community/roadmap)
+- [Best Practices](/docs/community/best-practices)
 
 ---
 
@@ -241,8 +241,8 @@ Contribute and collaborate
 Stop writing repetitive UI code. Start building with ObjectUI.
 
 <div style="display: flex; gap: 1rem; margin-top: 2rem;">
-  <a href="/guide/quick-start" style="padding: 0.75rem 1.5rem; background: #3b82f6; color: white; border-radius: 0.5rem; text-decoration: none; font-weight: 600;">Get Started →</a>
-  <a href="/components/" style="padding: 0.75rem 1.5rem; border: 1px solid #3b82f6; color: #3b82f6; border-radius: 0.5rem; text-decoration: none; font-weight: 600;">View Components</a>
-  <a href="/guide/showcase" style="padding: 0.75rem 1.5rem; border: 1px solid #6b7280; color: #6b7280; border-radius: 0.5rem; text-decoration: none; font-weight: 600;">Try Showcase</a>
+  <a href="/docs/guide/quick-start" style="padding: 0.75rem 1.5rem; background: #3b82f6; color: white; border-radius: 0.5rem; text-decoration: none; font-weight: 600;">Get Started →</a>
+  <a href="/docs/components/" style="padding: 0.75rem 1.5rem; border: 1px solid #3b82f6; color: #3b82f6; border-radius: 0.5rem; text-decoration: none; font-weight: 600;">View Components</a>
+  <a href="/docs/guide/showcase" style="padding: 0.75rem 1.5rem; border: 1px solid #6b7280; color: #6b7280; border-radius: 0.5rem; text-decoration: none; font-weight: 600;">Try Showcase</a>
 </div>
 

docs/plugins/plugin-markdown.mdx

@@ -189,7 +189,7 @@ npm install our-package
 2. Configure your settings
 3. Start building!
 
-For more information, see the [API Reference](/docs/reference/api).
+For more information, see the [API Reference](/docs/reference/api/core).
   `,
   className: 'prose prose-lg max-w-none'
 }

lychee.toml

@@ -0,0 +1,56 @@
+# Lychee configuration file for ObjectUI documentation link checking
+# This configuration enables checking internal fumadocs links by mapping
+# Next.js routes (e.g., /docs/guide) to filesystem paths (e.g., docs/guide.mdx)
+
+# Maximum number of concurrent requests
+max_concurrency = 10
+
+# Timeout for each request (in seconds)
+timeout = 20
+
+# Number of retries per request
+max_retries = 3
+
+# Accept any valid status code (2xx, 3xx)
+accept = [200, 204, 206, 301, 302, 303, 307, 308]
+
+# Exclude patterns - files and URLs to skip
+exclude = [
+    # Local development URLs
+    "http://localhost*",
+    "https://localhost*",
+    
+    # Example and placeholder URLs
+    "https://example.com",
+    "http://example.com",
+    
+    # Social media (anti-scraping)
+    "https://twitter.com*",
+    "https://x.com*",
+    
+    # GitHub specific patterns that may cause false positives
+    "https://github.com/.*/compare/*",
+    "https://github.com/.*/commit/*",
+]
+
+# Path remapping for fumadocs internal links
+# Maps Next.js routes to actual file paths
+[[remap]]
+# Map /docs/* links to docs/*.mdx or docs/*.md files
+pattern = "^/docs/(.*)$"
+replace = "file://./docs/$1.mdx"
+
+[[remap]]
+# Also try .md extension if .mdx doesn't exist
+pattern = "^/docs/(.*)$"
+replace = "file://./docs/$1.md"
+
+[[remap]]
+# Handle index files (e.g., /docs/components/ -> docs/components/index.mdx)
+pattern = "^/docs/(.*)/+$"
+replace = "file://./docs/$1/index.mdx"
+
+# Cache configuration
+[cache]
+# Don't use cache to ensure fresh results
+max_age = "0s"