Skip to content

fix(docs): update guide links #15265

Merged
StephanieJoly4 merged 2 commits intotwentyhq:mainfrom
marcmaceira:fix/replace-broken-links
Oct 22, 2025
Merged

fix(docs): update guide links #15265
StephanieJoly4 merged 2 commits intotwentyhq:mainfrom
marcmaceira:fix/replace-broken-links

Conversation

@marcmaceira
Copy link
Copy Markdown
Contributor

  • Update user guide links for email integration, notes, tasks, and API/webhooks sections to reflect new route structure

Currently, navigating using Algolia's search can result in 404s due to broken links:
Screenshot 2025-10-22 at 10 36 55 AM

…s, and API/webhooks sections to reflect new route structure
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Greptile Overview

Greptile Summary

This PR fixes broken internal documentation links that were causing 404 errors when users navigated via Algolia search. The changes update link paths across two documentation files to reflect a reorganization of the user guide route structure: features previously under /functions/ are now correctly routed to either /integrations/ (for emails, API/webhooks) or /collaboration/ (for notes, tasks). Specifically, four links in what-is-twenty.mdx are updated (Email Integration, Notes, Tasks, and API & Webhooks), and one link in integrations.mdx is corrected (API key generation). This is a pure documentation maintenance change that aligns internal links with the actual file locations and routing structure, ensuring users can successfully navigate to referenced content pages.

Important Files Changed

Changed Files
Filename Score Overview
packages/twenty-website/src/content/user-guide/getting-started/what-is-twenty.mdx 5/5 Updated four documentation links to fix broken navigation paths by changing routes from /functions/ to /integrations/ and /collaboration/ sections
packages/twenty-website/src/content/user-guide/integrations/integrations.mdx 5/5 Corrected API key generation link from /functions/api-webhooks to /integrations/api-webhooks

Confidence score: 5/5

  • This PR is safe to merge with minimal risk
  • All changes are limited to markdown documentation link updates with no code logic changes, and the new paths align with the actual route structure to resolve confirmed 404 errors
  • No files require special attention

Sequence Diagram

sequenceDiagram
    participant User
    participant "Documentation Page" as Docs
    participant "Algolia Search" as Search
    participant "MDX Files" as MDX
    
    User->>Docs: "Navigate to documentation"
    User->>Search: "Search for content (e.g., email, notes, tasks)"
    Search->>User: "Return search results with links"
    User->>Docs: "Click on search result link"
    Note over Docs: Old route structure causes 404
    Docs-->>User: "404 Error - Page not found"
    
    Note over MDX: Fix applied: Update links in MDX files
    MDX->>MDX: "Update email integration link to /user-guide/section/integrations/emails"
    MDX->>MDX: "Update notes link to /user-guide/section/collaboration/notes"
    MDX->>MDX: "Update tasks link to /user-guide/section/collaboration/tasks"
    MDX->>MDX: "Update API/webhooks link to /user-guide/section/integrations/api-webhooks"
    
    User->>Search: "Search for content again"
    Search->>User: "Return search results with updated links"
    User->>Docs: "Click on search result link"
    Docs->>User: "Successfully load correct page"
Loading

2 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

Copy link
Copy Markdown
Contributor

@StephanieJoly4 StephanieJoly4 left a comment

Choose a reason for hiding this comment

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

thanks @marcmaceira, good catch!

@StephanieJoly4 StephanieJoly4 merged commit 63a75dd into twentyhq:main Oct 22, 2025
38 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants