docs: Navigation restructure #989
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
New navigation structure with 6 tabs: - Docs (intro, quick start, solutions, for your business) - Data Catalog (curated, EVM, non-EVM, decoded, community, spellbook) - Access (with product dropdowns): * Explore and Analyze (Analytics Hub) * Programmatic Access (API Reference, SDKs, Webhooks) * Datashare (Snowflake, BigQuery, Databricks) * Connect your Tools (Trino Connectors) * Transform Data (dbt Connector) * For Blockchains (Catalyst) - SQL Query Engine (functions, syntax, datatypes) - Enterprise (with product dropdowns): * Analytics Hub (Teams, SSO, Permissions) * Datashare * Catalyst - Resources (credits & billing, learning, support, community) Implements Mintlify dropdown navigation similar to Coinbase CDP docs.
PR SummaryMajor docs overhaul introducing a new navigation and extensive stub content across the site.
Written by Cursor Bugbot for commit 6ae0de1. Configure here. |
Navigation restructure with 6 tabs using EXISTING pages: - Docs: Get Started content - Data Catalog: Existing curated, EVM, non-EVM data - Access (dropdowns): Analytics Hub, API, Datashare, Connectors, Catalyst - SQL Query Engine: Existing query-engine content - Enterprise (dropdowns): Teams, SSO, Datashare, Catalyst - Resources: Credits, Learning, Support Removed all [TODO] stub files - now uses real documentation.
Access dropdown with grouped headers: - ANALYTICS HUB / QUERY EDITOR / VISUALIZATIONS - API REFERENCE / EXECUTIONS / CLIENT SDKS / WEBHOOKS - DATA WAREHOUSE DELIVERY - TRINO CONNECTORS / TRANSFORM DATA - CATALYST Enterprise dropdown with grouped headers: - TEAM MANAGEMENT / SECURITY / ACTIVITY - ENTERPRISE DATA DELIVERY - BLOCKCHAIN INTEGRATION SQL Query Engine: Exact copy of current Query Engine structure All existing pages preserved
- Docs: Full Get Started content - Data Catalog: Full Data Catalog content - Access (dropdowns): * Explore and Analyze: Full Analytics Hub content * Programmatic Access: Full APIs & Connectors content * Datashare: Full Datashare content * For Blockchains: Full Catalyst content - SQL Query Engine: Full Query Engine content - Enterprise (dropdowns): Teams, SSO, Datashare, Catalyst - Resources: Credits, Learning, Support Total: 1321 pages (all existing pages preserved)
6 Nav Tabs: - Docs (from Get Started) - Data Catalog (unchanged) - Access (Coinbase-style dropdown with 4 products): * Analytics Hub (30 pages) * API Reference (104 pages) * Datashare (6 pages) * Catalyst (2 pages) - SQL Query Engine (exact copy of Query Engine) - Enterprise (dropdown with 3 products) - Resources (Credits, Learning, Support) Each dropdown shows a product selector at the top of the sidebar, exactly like Coinbase CDP docs.
Nav Tabs (6): - Docs - Data Catalog - Access (Coinbase-style dropdown) - SQL Query Engine (exact copy of Query Engine) - Enterprise (Coinbase-style dropdown) - Resources Access Dropdown: ├─ Explore and Analyze → Analytics Hub (full content) ├─ Programmatic Access → API Reference, Client SDKs, Real-Time APIs, Webhooks ├─ Datashare → Data Warehouse Delivery ├─ Connect your Tools → Trino Connectors ├─ Transform Data → dbt Connector └─ For Blockchains → Catalyst Enterprise Dropdown: ├─ Analytics Hub (Teams, SSO, Activity) ├─ Datashare └─ Catalyst
Access tab with category headers (like Coinbase): - EXPLORE AND ANALYZE → Analytics Hub - PROGRAMMATIC ACCESS → API Reference, Client SDKs, Real-Time APIs, Webhooks - DATA DELIVERY → Datashare - INTEGRATIONS → Trino Connectors, dbt Connector - FOR BLOCKCHAINS → Catalyst Enterprise tab with dedicated content (not routing elsewhere): - Overview page - ANALYTICS HUB: Teams, SSO, Permissions (stub content) - DATASHARE: Enterprise data delivery (stub content) - CATALYST: Enterprise blockchain integration (stub content) SQL Query Engine: Exact copy of current Query Engine
Access tab dropdown shows products: - Analytics Hub - API Reference - Datashare - Trino Connectors - dbt Connector - Catalyst Enterprise tab dropdown shows: - Analytics Hub - Datashare - Catalyst Each dropdown item opens that product's documentation.
Implements Mintlify's versions feature to create a dropdown selector: DROPDOWN OPTIONS (9 products): - Analytics Hub - API Reference - Client SDKs - Real-Time APIs - Webhooks - Datashare - Trino Connector - dbt Connector - Catalyst DROPDOWN CATEGORIES: - EXPLORE AND ANALYZE: Analytics Hub - PROGRAMMATIC ACCESS: API Reference, Client SDKs, Real-Time APIs, Webhooks - DATA DELIVERY: Datashare - INTEGRATIONS: Trino Connector, dbt Connector - FOR BLOCKCHAINS: Catalyst NAVIGATION TABS: - Get Started - Data Catalog - Access Methods (with dropdown) - SQL Query Engine - Resources Created 111 stub files in access-methods/ folder.
Changed from 'versions' to 'dropdowns' inside the tab navigation. This creates an expandable menu at the TOP of the sidebar. Each dropdown item shows its own navigation when selected: - Analytics Hub - API Reference - Client SDKs - Real-Time APIs - Webhooks - Datashare - Trino Connector - dbt Connector - Catalyst
Testing Coinbase-style dropdown with: - One 'Select Product' dropdown - Groups for categories (EXPLORE AND ANALYZE, PROGRAMMATIC ACCESS, etc.) - Page objects with href links inside each group
Structure:
navigation:
dropdowns: [
{
dropdown: 'Select Access Method',
groups: [
{ group: 'EXPLORE AND ANALYZE', pages: [...] },
{ group: 'PROGRAMMATIC ACCESS', pages: [...] },
{ group: 'DATA DELIVERY', pages: [...] },
{ group: 'INTEGRATIONS', pages: [...] },
{ group: 'FOR BLOCKCHAINS', pages: [...] }
]
}
]
tabs: [...]
This should create a dropdown at the very top of the sidebar with
category headers inside the dropdown menu.
Added custom JavaScript and CSS to create a dropdown selector at the top of the Access Methods sidebar with category headers: DROPDOWN STRUCTURE: ┌─────────────────────────────────────┐ │ 📊 Analytics Hub ▼ │ ├─────────────────────────────────────┤ │ EXPLORE AND ANALYZE │ ← Category header │ 📊 Analytics Hub │ │ │ │ PROGRAMMATIC ACCESS │ ← Category header │ 🔌 API Reference │ │ 📦 Client SDKs │ │ ⚡ Real-Time APIs │ │ 🔔 Webhooks │ │ │ │ DATA DELIVERY │ ← Category header │ ❄️ Datashare │ │ │ │ INTEGRATIONS │ ← Category header │ 🔗 Trino Connector │ │ 🔧 dbt Connector │ │ │ │ FOR BLOCKCHAINS │ ← Category header │ ⛓️ Catalyst │ └─────────────────────────────────────┘ Files added: - access-method-dropdown.js - Dropdown logic and rendering - access-method-dropdown.css - Standalone styles (backup) - styles.css - Updated with dropdown styles The JS automatically detects Access Methods pages and injects the dropdown at the top of the sidebar.
1. Fixed URL check to only show dropdown on /access-methods/ pages
- Properly checks path.startsWith('/access-methods/')
- Removes dropdown when navigating to other tabs
2. Replaced emoji icons with clean SVG line icons:
- Analytics Hub: bar chart
- API Reference: code brackets </>
- Client SDKs: package/cube
- Real-Time APIs: lightning bolt
- Webhooks: bell
- Datashare: database
- Trino Connector: link
- dbt Connector: sync arrows
- Catalyst: grid/table
Icons now match Mintlify's style (16px stroke icons)
- Added extensive list of sidebar selectors to find Mintlify's sidebar - Added console logging for debugging - Added multiple retry attempts (1s, 2s, 3s delays) - Improved path checking for Access Methods pages - Re-inserts dropdown if it gets removed by SPA navigation
Changes: - Added Access Overview anchor that defaults when clicking Access tab - Added api-reference/connectors/dbt-connector to dbt Connector section - Added api-reference/connectors/sql-operations to dbt Connector section - Updated access-method-dropdown.js with Overview category - Added star icon to Access Overview page dbt Connector now includes: - Overview - dbt Connector (full docs from api-reference) - Supported SQL Operations (from api-reference) - Setup, Building Models, Materialized Views, etc.
- Removed Real-Time APIs / Sim APIs section from Access Overview page - Updated isAccessMethodsPage() to include api-reference/connectors paths - Updated getCurrentMethod() to detect dbt-connector and sql-operations pages - Dropdown now appears on all dbt connector related pages
- Added api-reference/webhooks/webhook to isAccessMethodsPage() - Added detection in getCurrentMethod() to show as Webhooks section
- Updated page title in access-methods/index.mdx - Updated heading to 'APIs & Connectors' - Updated dropdown name in access-method-dropdown.js
- Removed separate Overview anchor from docs.json
- APIs & Connectors Overview is now the first page in API Reference
- Removed OVERVIEW category from dropdown
- Tab now defaults to API Reference section
- Updated getCurrentMethod() to handle overview page as API Reference
Dropdown now shows:
├── PROGRAMMATIC ACCESS
│ ├── API Reference (includes Overview as first page)
│ ├── Client SDKs
│ └── Webhooks
├── CONNECT YOUR TOOLS
│ └── BI Visualization Tools
└── TRANSFORM DATA
└── dbt Connector
- Added updateDropdownSelection() function - Updates trigger icon and name based on current URL - Updates active states and checkmarks in dropdown menu - Called when dropdown already exists but URL changed
Major changes: 1. Removed custom dropdown from APIs & Connectors 2. Renamed 'APIs & Connectors' tab to 'API Reference' 3. Moved 'BI Visualization Tools' and 'dbt Connector' to Docs tab 4. Integrated Client SDKs and Webhooks into API Reference sidebar API Reference tab now has simple sidebar navigation: - Overview - Getting Started - Authentication - Executions and Results - Query Management - Data Uploads - Materialized Views - Post-processing - Client SDKs (Python, TypeScript, Go) - Webhooks - Resources Docs tab now includes: - ... existing content ... - BI Visualization Tools (Hex, Metabase, Tableau, etc.) - dbt Connector Deleted: - access-method-dropdown.js - access-method-dropdown.css - Cleaned up styles.css
Deleted orphaned directories (not referenced in docs.json): - access-methods/analytics-hub/ (25 files) - access-methods/catalyst/ (7 files) - access-methods/datashare/ (10 files) - access-methods/real-time-apis/ (2 files) Deleted unused files: - mint.json.backup - zz_unused/ (7 files) These files were created during the dropdown navigation work but are no longer needed after simplifying to the standard sidebar navigation.
BI Visualization Tools now contains: - Trino Connector Overview - Trino Connector (from api-reference/connectors/trino-connector) dbt Connector now contains: - dbt Connector Overview - dbt Connector (from api-reference/connectors/dbt-connector) - Supported SQL Operations (from api-reference/connectors/sql-operations) Removed orphaned files: - access-methods/trino-connector/*.mdx (connection-parameters, hex, metabase, etc.) - access-methods/dbt-connector/*.mdx (setup, building-models, etc.)
Changes: - Remove icon from BI Visualization Tools group header - Remove icon from dbt Connector group header - Rename 'dbt Connector' group to 'Transform your Data' - Rename Trino Connector to 'Trino Connector Overview' with star icon - Rename dbt Connector to 'dbt Connector Overview' with star icon Note: Client SDKs already has 'package' icon in docs.json
…alytics Hub New order in Docs tab: 1. Analytics Hub 2. Transform your Data 3. BI Visualization Tools 4. Dune Datashare 5. Catalyst
Connectors are now in the Docs tab under Transform your Data and BI Visualization Tools
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New navigation structure with 6 tabs:
Implements Mintlify dropdown navigation