Fixing broken links

[guergabo]

why

Broken links.

what changed

Fixed broken links + added broken links checker for the future.

test plan

This PR.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 4828b63

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[greptile-apps]

Greptile Overview

Summary

Fixed broken documentation links across multiple doc files and added a GitHub Actions workflow to automatically check for broken links in future documentation changes.

Key Changes:

• Added npx mintlify broken-links workflow that runs on all docs/** changes
• Fixed 5 broken internal links pointing to non-existent or incorrect documentation paths
• Updated links to point to correct paths: /configuration/logging, /best-practices/caching, and /integrations/vercel/introduction

Issue Found:

• docs/best-practices/deployments.mdx:174 - Missing leading / in link path, causing relative instead of absolute path resolution

Confidence Score: 4/5

• This PR is safe to merge after fixing the relative path issue
• The PR successfully fixes broken links and adds automated checking for the future. One syntax error was found where a link is missing the leading /, which will cause incorrect relative path resolution. This is a minor but important fix needed before merge.
• docs/best-practices/deployments.mdx needs the leading / added to the link on line 174

Important Files Changed

File Analysis

Filename	Score	Overview
.github/workflows/docs.yml	5/5	Added automated broken links checker workflow for documentation changes
docs/basics/observe.mdx	5/5	Fixed broken links to logging configuration and caching best practices
docs/best-practices/deployments.mdx	3/5	Fixed browser environment link but missing leading slash causing relative path issue
docs/integrations/vercel/introduction.mdx	5/5	Fixed self-referencing quickstart link that was pointing to non-existent path

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant GH as GitHub
    participant CI as CI Workflow
    participant Mintlify as Mintlify CLI
    
    Dev->>GH: Push changes to docs/**
    GH->>CI: Trigger "Check Docs Links" workflow
    CI->>CI: Checkout code
    CI->>CI: Setup Node.js 20
    CI->>Mintlify: Run npx mintlify broken-links
    Mintlify->>Mintlify: Scan all doc files
    Mintlify->>Mintlify: Check internal links
    Mintlify->>Mintlify: Check external links
    alt Broken links found
        Mintlify->>CI: Exit with error
        CI->>GH: Workflow fails ❌
        GH->>Dev: Notify of broken links
    else All links valid
        Mintlify->>CI: Exit success
        CI->>GH: Workflow passes ✅
    end

Loading

_{4 files reviewed, 1 comment}

_{Edit Code Review Agent Settings | Greptile}

[greptile-apps]

syntax: missing leading / in the link path - should be /configuration/browser#browserbase-environment for absolute path resolution

Suggested change

	See also: [Browser Environment](configuration/browser#browserbase-environment) for details on required variables.
	See also: [Browser Environment](/configuration/browser#browserbase-environment) for details on required variables.

Prompt To Fix With AI

This is a comment left during a code review.
Path: docs/best-practices/deployments.mdx
Line: 174:174

Comment:
**syntax:** missing leading `/` in the link path - should be `/configuration/browser#browserbase-environment` for absolute path resolution

```suggestion
See also: [Browser Environment](/configuration/browser#browserbase-environment) for details on required variables.
```

How can I resolve this? If you propose a fix, please make it concise.

[greptile-apps]

Greptile Overview

Summary

This PR fixes broken documentation links across three files. The changes update outdated internal links to point to correct documentation pages and anchors that actually exist in the codebase.

Key changes:

• Updated two links in docs/basics/observe.mdx from /best-practices/debugging-workflows to /configuration/logging
• Fixed best practices card link from /best-practices/best-practices to /best-practices/caching
• Corrected browser environment link in docs/best-practices/deployments.mdx to include proper anchor #browserbase-environment
• Fixed self-referencing link in docs/integrations/vercel/introduction.mdx from non-existent /integrations/vercel/quickstart to /integrations/vercel/introduction

All target files and anchors have been verified to exist.

Confidence Score: 5/5

• This PR is safe to merge with no risk - it only fixes documentation links
• All changes are documentation-only link fixes with no code impact. Target files and anchors have been verified to exist. The changes improve user experience by ensuring documentation links work correctly.
• No files require special attention

Important Files Changed

File Analysis

Filename	Score	Overview
docs/basics/observe.mdx	5/5	Fixed two broken documentation links to point to /configuration/logging and updated best practices link to /best-practices/caching
docs/best-practices/deployments.mdx	5/5	Fixed broken link to browser environment documentation with proper anchor #browserbase-environment
docs/integrations/vercel/introduction.mdx	5/5	Fixed self-referencing link that was pointing to non-existent quickstart page

Sequence Diagram

sequenceDiagram
    participant Developer
    participant PR
    participant Documentation
    
    Developer->>PR: Submit link fixes
    PR->>Documentation: Update observe.mdx links
    PR->>Documentation: Update deployments.mdx link
    PR->>Documentation: Update vercel introduction link
    Documentation-->>PR: All links validated
    PR-->>Developer: Ready to merge

Loading

_{2 files reviewed, no comments}

_{Edit Code Review Agent Settings | Greptile}