Use relative links and enforce it (#476)

evantahler · web-flow · commit 10d2f4ea6f6a · 2025-10-06T14:58:01.000-07:00
* Use relative links

* fix link tests
diff --git a/app/en/home/agentic-development/page.mdx b/app/en/home/agentic-development/page.mdx
@@ -5,16 +5,16 @@ description: "Learn how to speed up your development with agents in your IDEs"
 
 # Agentic Development
 
-Give your AI IDE access to Arcade.dev's documentation using our llms.txt files (short [llms.txt](https://docs.arcade.dev/llms.txt), [llms-full.txt](https://docs.arcade.dev/llms-full.txt)), or use [context7](https://context7.com/arcadeai/docs). This allows Claude Code, Cursor, and other AI IDEs to access the documentation and help you write code.
+Give your AI IDE access to Arcade.dev's documentation using our llms.txt files (short [llms.txt](/llms.txt), [llms-full.txt](/llms-full.txt)), or use [context7](https://context7.com/arcadeai/docs). This allows Claude Code, Cursor, and other AI IDEs to access the documentation and help you write code.
 
 ## LLMs.txt
 
 LLMs.txt is a file format that allows you to give your AI IDE access to Arcade.dev's documentation in a format that can be easily parsed by the LLM. All you need to do is paste in the conent of the file into your IDE's settings, or reference the docs, e.g. via [Cursor's `@docs` annotation](https://cursor.com/docs/context/symbols#docs).
 
 Our LLMs.txt files are available in two versions:
 
-- [`https://docs.arcade.dev/llms.txt`](https://docs.arcade.dev/llms.txt) - a short version of the documentation index
-- [`https://docs.arcade.dev/llms-full.txt`](https://docs.arcade.dev/llms-full.txt) - a full version of the documentation
+- [`/llms.txt`](/llms.txt) - a short version of the documentation index
+- [`/llms-full.txt`](/llms-full.txt) - a full version of the documentation
 
 ![LLMs.txt example](/images/agentic-development/cursor-llms-txt.png)
 
diff --git a/app/en/home/auth/secure-auth-production/page.mdx b/app/en/home/auth/secure-auth-production/page.mdx
@@ -29,7 +29,7 @@ The Arcade.dev user verifier helps keep your auth flows secure while you are bui
 <Callout type="info">
   Arcade's default OAuth apps can *only* be used with the Arcade user verifier.
   If you are building a multi-user production app, you must obtain your own OAuth app credentials and add them to Arcade.
-  For example, see our docs on [configuring Google auth in the Arcade Dashboard](https://docs.arcade.dev/home/auth-providers/google#access-the-arcade-dashboard).
+  For example, see our docs on [configuring Google auth in the Arcade Dashboard](/home/auth-providers/google#access-the-arcade-dashboard).
 </Callout>
 
 ## Build a custom user verifier
diff --git a/app/en/home/changelog/page.mdx b/app/en/home/changelog/page.mdx
@@ -14,8 +14,8 @@ _Here's what's new at Arcade.dev!_
 
 **Toolkits**
 
-- `[feature - 🚀]` Box.com Starter MCP Server released ([docs](https://docs.arcade.dev/mcp-servers/productivity/box-api))
-- `[feature - 🚀]` Stripe Starter MCP Server released ([docs](https://docs.arcade.dev/en/mcp-servers/payments/stripe_api))
+- `[feature - 🚀]` Box.com Starter MCP Server released ([docs](/en/mcp-servers/productivity/box-api))
+- `[feature - 🚀]` Stripe Starter MCP Server released ([docs](/en/mcp-servers/payments/stripe_api))
 
 **Misc**
 
@@ -25,9 +25,9 @@ _Here's what's new at Arcade.dev!_
 
 **Toolkits**
 
-- `[feature - 🚀]` Introduce [Starter Tools](https://docs.arcade.dev/home/use-tools/types-of-tools), a new type of tool that mirrors the original HTTP API design of the upstream service.
+- `[feature - 🚀]` Introduce [Starter Tools](/home/use-tools/types-of-tools), a new type of tool that mirrors the original HTTP API design of the upstream service.
 - `[feature - 🚀]` Release Slack started MCP Server which contains support for most of the Slack API.
-- `[feature - 🚀]` Include advanced error handling in the following MCP Servers: Google, Microsoft, Slack, and Asana. Learn more about handling tool errors [here](https://docs.arcade.dev/home/build-tools/handle-tool-errorsk).
+- `[feature - 🚀]` Include advanced error handling in the following MCP Servers: Google, Microsoft, Slack, and Asana. Learn more about handling tool errors [here](/home/build-tools/handle-tool-errors).
 - `[bugfix - 🐛]` [MCP Servers/MS Teams] Fix get_chat_metadata by chat's users
 - `[feature - 🚀]` [MCP Servers/confluence] Adding WhoAmI tools for Confluence
 
@@ -153,7 +153,7 @@ _Here's what's new at Arcade.dev!_
 
 **Toolkits**
 
-- `[feature - 🚀]` Sharepoint Toolkit added ([docs](https://docs.arcade.dev/mcp-servers/productivity/sharepoint))
+- `[feature - 🚀]` Sharepoint Toolkit added ([docs](/mcp-servers/productivity/sharepoint))
 - `[feature - 🚀]` Google Slides Toolkit added
 - `[feature - 🚀]` Commenting on Google Docs added
 - `[bugfix - 🐛]` Improvements in Microsoft Teams message search tool for better agentic experience. Fix bug when no messages match the search query.
@@ -320,23 +320,23 @@ Self-hosed Arcade developers cannot be grandfathered into the old (insecure) beh
 
 **Frameworks**
 
-- `[feature - 🚀]` Support for OpenAI Agent SDK in Typescript ([docs](https://docs.arcade.dev/home/oai-agents/overview) and [example](https://github.com/ArcadeAI/arcade-ai/tree/main/examples/openai-agents-ts))
+- `[feature - 🚀]` Support for OpenAI Agent SDK in Typescript ([docs](/home/oai-agents/overview) and [example](https://github.com/ArcadeAI/arcade-ai/tree/main/examples/openai-agents-ts))
 
 **Toolkits**
 
-- `[feature - 🚀]` Jira MCP Server released ([docs](https://docs.arcade.dev/mcp-servers/productivity/jira))
+- `[feature - 🚀]` Jira MCP Server released ([docs](/mcp-servers/productivity/jira))
 
 **CLI and TDK**
 
-- `[feature - 🚀]` V2.0 of Python Tool Development Kit (TDK) ([migration guide](https://docs.arcade.dev/home/migrate-to-v2))
+- `[feature - 🚀]` V2.0 of Python Tool Development Kit (TDK)
 - `[feature - 🚀]` Admin API client support
   - Requires v1.6.0 of `arcade-py`, or v1.8.0 of `arcade-js`, or v0.1.0-alpha.4 of `arcade-go`
 
 **Platform and Engine**
 
 - `[feature - 🚀]` Admin APIs released for managing users, secrets, and tools ([API References](https://reference.arcade.dev/api-reference#tag/admin))
 - `[bugfix - 🐛]` Unauthenticated MCP servers can be called anonymously
-- `[feature - 🚀]` End-user credentials and auth status can be fetched in batches ([docs](https://docs.arcade.dev/home/auth/tool-auth-status))
+- `[feature - 🚀]` End-user credentials and auth status can be fetched in batches ([docs](/home/auth/tool-auth-status))
 
 **Misc**
 
diff --git a/app/en/home/glossary/page.mdx b/app/en/home/glossary/page.mdx
@@ -25,7 +25,7 @@ A 'MCP Server' is a collection of tools that can be used by an agent, grouped lo
 
 A 'tool' is a function that can be called by an agent which performs some action - commonly via an API, filesystem, database, etc. Tools are written in Python and deployed by running a worker which contains the MCP Server's code. Tools are defined by the `@tool()` decorator and will be passed `ToolContext` as the first argument. If a tool has dependencies that are not met (a secret is not provided, for example), the tool will fail to execute.
 
-Tools are commonly referred to by a qualified name that includes their MCP Server. For example, [Gmail.SendEmail](https://docs.arcade.dev/mcp-servers/productivity/gmail#gmailsendemail)
+Tools are commonly referred to by a qualified name that includes their MCP Server. For example, [Gmail.SendEmail](/mcp-servers/productivity/gmail#gmailsendemail)
 
 _Learn more about [tools](/home/build-tools/create-a-mcp-server)._
 
@@ -151,7 +151,7 @@ The Arcade Engine is also responsible for the OAuth flow for your agent's users.
 
 ### Worker
 
-A 'worker' is a process that runs all the tools with a MCP Server. Workers are microservices that are called by the Arcade Engine to handle tool execution requests. Workers are either [deployed to Arcade's infrastructure](https://docs.arcade.dev/home/serve-tools/arcade-deploy) via `arcade deploy`, or run in your own infrastructure.
+A 'worker' is a process that runs all the tools with a MCP Server. Workers are microservices that are called by the Arcade Engine to handle tool execution requests. Workers are either [deployed to Arcade's infrastructure](/home/serve-tools/arcade-deploy) via `arcade deploy`, or run in your own infrastructure.
 
 _Learn more about workers [here](/home/deployment/on-prem-mcp).
 
diff --git a/app/en/home/vercelai/using-arcade-tools/page.mdx b/app/en/home/vercelai/using-arcade-tools/page.mdx
@@ -58,7 +58,7 @@ yarn install ai @ai-sdk/openai @arcadeai/arcadejs
 You'll need two API keys:
 
 - **OpenAI API key** from [OpenAI dashboard](https://platform.openai.com/api-keys)
-- **Arcade API key** from our [Getting your API key guide](https://docs.arcade.dev/home/api-keys)
+- **Arcade API key** from our [Getting your API key guide](/home/api-keys)
 
 Add them to your environment:
 
diff --git a/tests/broken-link-check.test.ts b/tests/broken-link-check.test.ts
@@ -6,6 +6,13 @@ import { expect, test } from "vitest";
 
 const TIMEOUT = 30_000;
 
+const staticFiles = [
+  "/llms.txt",
+  "/llms-full.txt",
+  "/robots.txt",
+  "/sitemap.xml",
+];
+
 // Function to validate anchor fragments by checking file content
 function validateAnchorFragment(filePath: string, fragment: string): boolean {
   try {
@@ -63,6 +70,10 @@ test(
         const [basePath, fragment] = url.split("#");
         const localeUrl = `/en${basePath}`;
 
+        if (staticFiles.includes(basePath)) {
+          return true;
+        }
+
         // Check if the base path exists with locale prefix
         const baseExists = scanned.urls?.has(localeUrl);
 
diff --git a/tests/internal-link-check.test.ts b/tests/internal-link-check.test.ts
@@ -0,0 +1,41 @@
+import { readFileSync } from "node:fs";
+import fg from "fast-glob";
+import { expect, test } from "vitest";
+
+const TIMEOUT = 30_000;
+
+test(
+  "check for absolute links to docs.arcade.dev",
+  async () => {
+    const files = await fg("app/**/*.{md,mdx}");
+    const absoluteLinkRegex = /https?:\/\/docs\.arcade\.dev\//gi;
+    const errors: Array<{ file: string; line: number; match: string }> = [];
+
+    for (const file of files) {
+      const content = readFileSync(file, "utf-8");
+      const lines = content.split("\n");
+
+      for (let i = 0; i < lines.length; i++) {
+        const matches = lines[i].match(absoluteLinkRegex);
+        if (matches) {
+          for (const match of matches) {
+            errors.push({
+              file,
+              line: i + 1,
+              match,
+            });
+          }
+        }
+      }
+    }
+
+    for (const error of errors) {
+      console.error(
+        `Absolute link found in ${error.file}:${error.line} - "${error.match}" should be a relative link`
+      );
+    }
+
+    expect(errors.length).toBe(0);
+  },
+  TIMEOUT
+);
