Skip to content

Fix broken custom networks link in installation docs #510

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

devin-ai-integration[bot]
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Jun 26, 2025

Fix broken custom networks link in installation docs

Summary

Fixed broken relative links to custom networks documentation in installation pages across all frameworks. The issue was in snippet files that are imported into installation documentation - they used relative paths (../../core/custom-networks) that worked from their original location but broke when imported into the installation context.

Files changed:

  • snippets/appkit/react/wagmi/about/implementation.mdx
  • snippets/appkit/vue/wagmi/about/implementation.mdx
  • snippets/appkit/next/wagmi/about/implementation.mdx
  • snippets/appkit/javascript/wagmi/about/implementation.mdx

Change: Updated relative path from ../../core/custom-networks to custom-networks in all affected snippet files.

Review & Testing Checklist for Human

  • Test custom networks link on ALL framework installation pages (React, Vue, Next.js, JavaScript) - I only tested React locally
  • Verify links work in production deployment - relative path behavior might differ between dev and prod
  • Check for other similar broken relative links - search for other ../../ patterns that might have same issue
  • Confirm custom networks page loads correctly from all installation page contexts

Diagram

graph TD
    A[appkit/react/core/installation.mdx]:::context
    B[appkit/vue/core/installation.mdx]:::context
    C[appkit/next/core/installation.mdx]:::context
    D[appkit/javascript/core/installation.mdx]:::context
    
    E[snippets/appkit/react/wagmi/about/implementation.mdx]:::major-edit
    F[snippets/appkit/vue/wagmi/about/implementation.mdx]:::major-edit
    G[snippets/appkit/next/wagmi/about/implementation.mdx]:::major-edit
    H[snippets/appkit/javascript/wagmi/about/implementation.mdx]:::major-edit
    
    I[appkit/react/core/custom-networks.mdx]:::context
    J[appkit/vue/core/custom-networks.mdx]:::context
    K[appkit/next/core/custom-networks.mdx]:::context
    L[appkit/javascript/core/custom-networks.mdx]:::context
    
    A --> E
    B --> F
    C --> G
    D --> H
    
    E -.->|custom-networks| I
    F -.->|custom-networks| J
    G -.->|custom-networks| K
    H -.->|custom-networks| L
    
    subgraph Legend
        L1[Major Edit]:::major-edit
        L2[Minor Edit]:::minor-edit
        L3[Context/No Edit]:::context
    end
    
    classDef major-edit fill:#90EE90
    classDef minor-edit fill:#87CEEB
    classDef context fill:#FFFFFF
Loading

Notes

  • Root cause: Snippet files assumed they were being viewed from /snippets/ directory, but when imported into installation docs (in /appkit/*/core/), the relative path ../../core/custom-networks no longer resolved correctly
  • Testing: Verified fix works locally on React installation page - link successfully navigates to custom networks documentation
  • Risk: Same snippets are reused across multiple frameworks, so comprehensive testing across all installation pages is critical

Link to Devin run: https://app.devin.ai/sessions/a7a7545db53d430d83d37dbbe9a6ea79

Requested by: enes@reown.com (enes@reown.com)

Local testing screenshot

Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@bkrem bkrem requested review from enesozturk and rohit-710 July 15, 2025 09:09
@bkrem
Copy link
Member

bkrem commented Jul 15, 2025

rebase this PR (so we get a mintlify deployment)

- Update relative path from '../../core/custom-networks' to 'custom-networks' in snippet files
- Fix affects React, Vue, Next.js, and JavaScript wagmi implementation snippets
- Links now work correctly when snippets are imported into installation documentation
- Both installation.mdx and custom-networks.mdx are in same directory (/appkit/react/core/)

Co-Authored-By: enes@reown.com <enes@reown.com>
@devin-ai-integration devin-ai-integration bot force-pushed the devin/1750940512-fix-custom-networks-link branch from bf7815c to ba8a479 Compare July 15, 2025 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant