Skip to content

Comments

docs: restructure sidebar navigation for clarity#747

Merged
0xmkh merged 9 commits intomainfrom
devin/1771418603-sidebar-restructure
Feb 20, 2026
Merged

docs: restructure sidebar navigation for clarity#747
0xmkh merged 9 commits intomainfrom
devin/1771418603-sidebar-restructure

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Feb 18, 2026

Description

Restructures the AppKit sidebar to improve discoverability and organization, and rewrites the overview page content. Requested by Jem Conlon.

Sidebar changes (docs.json) — AppKit Overview tab:

  • Removed "Features" section — pages redistributed into more specific groups
  • Removed "Paid Plans" section — Pro and Enterprise plan pages now nested under a "Pricing Plans" dropdown inside "Getting Started"
  • New "Accounts & Authentication" section — contains the Authentication subgroup (socials, one-click-auth, SIWX) and Smart Accounts
  • New "Payments" section — Swaps & Onramp moved to top (directly under Payments Overview), followed by Pay with Exchange, Deposit with Exchange, One-click Checkout
  • New "Multichain Tools" section — contains Multichain Support and Chain Abstraction
  • New "Dashboard" section — contains Analytics (moved from Dashboard & Advanced tab)
  • New "Interactions" section — contains Blockchain API (moved from Dashboard & Advanced tab) and Embedded Wallets Interactions (moved from Accounts & Authentication)
  • Renamed "Network" → "Supported Networks"
  • Renamed "Integrations" → "Use Cases" and repositioned after Supported Networks
  • Renamed "AppKit Guides" → "How Tos"
  • Moved Guides and Migration sections out of AppKit Overview tab → into Advanced tab
  • Final section order: Getting Started → Accounts & Authentication → Payments → Multichain Tools → Dashboard → Interactions → Supported Networks → Use Cases → Technical Reference

Sidebar changes (docs.json) — "Dashboard & Advanced" tab → renamed to "Advanced":

  • Renamed tab from "Dashboard & Advanced" to "Advanced"
  • Dissolved the "Dashboard" group — its contents were redistributed:
    • WalletGuide and Relay → moved into the "Advanced" group
    • Blockchain API → moved to new "Interactions" section in AppKit Overview
    • Analytics → moved to new "Dashboard" section in AppKit Overview
    • cloud/reown-authenticationremoved from sidebar entirely
  • Dissolved the "Upgrade" section — all upgrade pages merged into "Migration":
    • "Web3Modal to Reown AppKit" group (with all platform-specific pages) → moved under Migration
    • "WalletConnect Modal to Reown AppKit Core" (appkit/upgrade/wcm) → moved under Migration
    • Removed the intermediate "AppKit" dropdown wrapper
  • New "Migrate from other libraries" dropdown under Migration — nests Privy, RainbowKit, ConnectKit, and Anza Adapter pages
  • Final section order: Migration → Advanced → Guides → Technical Reference

Page content changes (appkit/overview.mdx):

  • Renamed page title from "Overview" to "About Reown SDK"
  • Rewrote intro section with structured feature categories (Accounts & Authentication, Payments Solutions, Multichain Tools, Flexible Frameworks & Platform Support) and internal links to relevant docs pages
  • Removed the autoplay video element that was between the intro and the Demo heading
  • Removed the entire "Features" section (14 feature descriptions) — this content is now covered by the structured intro and individual feature pages
  • Merged the framework support table from appkit/features/index.mdx into this page
  • Added new "Reown SDK (AppKit) vs AppKit Core" comparison section after the Framework Support table, with explanation and feature comparison table
  • Fixed broken #features anchor link (removed reference to deleted heading)

Known limitations / items for review

  • Anchors (Contact Us / Community / Blog) remain in global position. Mintlify does not support placing anchor objects inside a dropdown's pages array — doing so broke the entire AppKit Overview dropdown. Anchors have been left in the original global.anchors config, which renders them at the top of every sidebar.
  • SIWX cross-link removed from Multichain Tools. Duplicating appkit/authentication/siwx/default across two sidebar groups also contributed to the dropdown routing failure. SIWX remains accessible under Accounts & Authentication > Authentication.
  • Orphaned pages:
    • appkit/features/index.mdx is no longer in the sidebar but the file still exists. Consider whether a redirect from the old URL is needed.
    • cloud/reown-authentication was removed from the sidebar entirely. Consider whether a redirect is needed.
  • Video removed: The <video> element (appkit-overview-demo.mp4) was removed as part of replacing the intro text. Verify this is intended.

Items requiring human review

  • Cross-directory references: cloud/blockchain-api and cloud/analytics are now referenced in the AppKit Overview sidebar but live under the cloud/ directory. Verify these render correctly in Mintlify.
  • "(SIWE)" in intro: The first bullet under Accounts & Authentication reads "Connections to 600+ wallets via the WalletConnect Network (SIWE)" — confirm the parenthetical is correct and complete.
  • Embedded Wallets Interactions moved: Verify that moving appkit/features/smart-accounts-interaction from "Accounts & Authentication" to the new "Interactions" section makes semantic sense.
  • Guides/Migration moved to Advanced tab: Confirm that moving these sections out of the main AppKit Overview tab into the Advanced tab is the intended user experience.
  • Upgrade section merged into Migration: Verify that dissolving the "Upgrade" section and merging all upgrade pages into "Migration" makes semantic sense. The "Web3Modal to Reown AppKit" content is now a sibling of "Migrate from other libraries" under Migration.
  • Section ordering: Confirm the final ordering in both tabs matches expectations (see "Final section order" bullets above).
  • cloud/reown-authentication removed: This page was removed from the sidebar entirely. Confirm this is intentional and consider whether a redirect is needed.
  • Confirm the removal of all 14 feature descriptions from the overview page is intentional (content only lives in individual feature pages now).
  • Verify the AppKit vs AppKit Core comparison table content is accurate.
  • Confirm video removal is intended, or whether it should be re-added below the new intro.

Link to Devin run

Tests

  • - Ran the changes locally with Mintlify and confirmed that the changes appear as expected.
  • - Ran a grammar check on the updated/created content using ChatGPT.

Direct link to the deployed preview files

Co-Authored-By: Jem Conlon <jem@walletconnect.com>
@devin-ai-integration
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

@claude
Copy link

claude bot commented Feb 18, 2026

Claude finished @devin-ai-integration[bot]'s task in 1m 30s —— View job


PR Review

  • Gather context
  • Read tone of voice guidelines
  • Read changed files
  • Analyze and post review

Found 4 issue(s)

Issue 1: Anchor objects placed inside pages array — likely invalid Mintlify schema

ID: docs-anchor-in-pages-invalid-a3c1
File: docs.json:201-215
Severity: HIGH
Category: breaking_change

Context:

  • Pattern: Three anchor objects (Contact Us, Community, Blog) are now placed inside the pages array of the AppKit - Overview dropdown, alongside group objects.
  • Risk: Mintlify's navigation schema treats pages arrays as containing either string page paths or group objects. anchor objects are a distinct navigation primitive (previously used in global.anchors). Mixing them inside a pages array is likely unsupported and may cause a build/render failure or silently drop the anchors.
  • Impact: The sidebar could break or the anchors may not render at all in the deployed preview.
  • Trigger: Any Mintlify build/deploy after this change. The PR author flagged this as a key review item — it needs a live Mintlify test to confirm.

Recommendation: Verify Mintlify supports anchor objects inside a dropdown's pages array. If not, the correct approach is to keep them in global.anchors or use a supported navigation primitive (e.g., a group with external href pages if supported). The PR should not be merged until the checkbox "Ran the changes locally with Mintlify" is checked.


Issue 2: Duplicate page path appkit/authentication/siwx/default in two sidebar groups

ID: docs-siwx-duplicate-path-b8f2
File: docs.json:88 and docs.json:116
Severity: MEDIUM
Category: breaking_change

Context:

  • Pattern: appkit/authentication/siwx/default appears in both Accounts & Authentication > Authentication (line ~88) and Multichain Tools (line ~116).
  • Risk: Mintlify's behavior with duplicate page paths is undefined/undocumented. It may render the page under one section only, produce a build warning, or cause routing conflicts.
  • Impact: Users navigating the sidebar may see inconsistent active states or the page may not appear in both sections as intended.
  • Trigger: Sidebar rendering in Mintlify. The PR author flagged this — confirm Mintlify handles it before merging.

Recommendation: If cross-linking is required, check Mintlify docs for a supported cross-reference mechanism. If none exists, consider linking to SIWX from a short description in the Multichain Tools group description rather than duplicating the page entry.


Issue 3: Orphaned page appkit/features/index.mdx — no redirect configured

ID: docs-features-index-orphaned-c5d3
File: docs.json (omission)
Severity: MEDIUM
Category: breaking_change

Context:

  • Pattern: appkit/features/index was removed from the sidebar navigation but the file still exists. No redirect was added in docs.json.
  • Risk: Any existing external links, bookmarks, or search engine indexed URLs pointing to /appkit/features or /appkit/features/index will now return a 404.
  • Impact: Broken inbound links; SEO degradation for a page that was previously in the sidebar.
  • Trigger: Any external traffic to the old URL after deploy.

Recommendation: Add a redirect in docs.json under the redirects key:

{ "source": "/appkit/features", "destination": "/appkit/overview" },
{ "source": "/appkit/features/index", "destination": "/appkit/overview" }

Issue 4: overview.mdx title "About Reown SDK" is ambiguous — page is AppKit-specific

ID: overview-title-misleading-d1e4
File: appkit/overview.mdx:2
Severity: LOW
Category: code_quality

Context:

  • Pattern: Title changed from "Overview" to "About Reown SDK", but the page content is entirely about AppKit specifically, not the full Reown SDK portfolio (which also includes WalletKit, etc.).
  • Risk: Misleads users who land on this page expecting a top-level Reown product overview. The body copy correctly says "Reown AppKit is…" but the title implies broader scope.
  • Impact: Minor discoverability confusion; could affect SEO for queries about "Reown SDK" vs "AppKit".

Recommendation: Use "About AppKit" or "AppKit Overview" to match the scoped content. If the intent is to position AppKit as the primary Reown SDK, clarify that in the introductory sentence rather than via the title alone.

Summary of key items flagged in PR description:

  1. Anchors scope change — placement inside pages[] is architecturally risky (Issue 1 above). Needs live Mintlify validation before merge.
  2. Duplicate SIWX entry — flagged as Issue 2; Mintlify behavior is unverified.
  3. Orphaned features/index page — needs a redirect (Issue 3).

The PR should not be merged until the local Mintlify test checkbox is checked and Issues 1 and 2 are confirmed non-breaking.

Co-Authored-By: Jem Conlon <jem@walletconnect.com>
devin-ai-integration bot and others added 2 commits February 18, 2026 14:26
Co-Authored-By: Jem Conlon <jem@walletconnect.com>
Co-Authored-By: Jem Conlon <jem@walletconnect.com>
Co-Authored-By: Jem Conlon <jem@walletconnect.com>
Copy link
Contributor Author

@devin-ai-integration devin-ai-integration bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 2 additional findings.

Open in Devin Review

…Plans section

Co-Authored-By: Jem Conlon <jem@walletconnect.com>
@mintlify mintlify bot requested a deployment to staging February 18, 2026 15:15 Abandoned
…gration to Advanced tab

Co-Authored-By: Jem Conlon <jem@walletconnect.com>
…uides after Advanced

Co-Authored-By: Jem Conlon <jem@walletconnect.com>
…ove Interactions

Co-Authored-By: Jem Conlon <jem@walletconnect.com>
@0xmkh 0xmkh merged commit ffe4651 into main Feb 20, 2026
4 checks passed
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