Skip to content

Commit 28f3cf3

Browse files
AlannaBurkeManus Agent
andauthored
Fix top navbar and left sidebar navigation, adding pathways (#18026)
## Summary Fixes the top navigation bar and left sidebar across the ExecuTorch docs site. Builds on the decision matrix / user pathways work from the previous commit. ## Changes ### Top Navbar (`conf.py` ) - **Removed all dropdown menus** — set `enable_navbar_dropdowns: False` so every top-level nav item is a flat, direct link with no hover dropdown - **Removed the "More" overflow dropdown** — raised `header_links_before_dropdown` to `10` so all 9 nav items are always visible - Added `navigation_depth: 2`, `show_nav_level: 1`, `collapse_navigation: False` for consistent left sidebar depth ### Top-Level Nav Structure (`index.md`) - Reduced from 10 to 9 top-level toctree items by merging `api-section` into `advanced-topics-section` - Consolidated the "Explore Documentation" section from 9 stacked single-card grids into one clean 3-column grid ### API Reference (`advanced-topics-section.md`) - Added an "API Reference" section with links to all 7 API docs - Added the 7 API pages to the section's toctree so they appear in the left sidebar under Advanced ### Pathway Pages Sidebar (`user-pathways.md`, `pathway-*.md`) - Renamed the `user-pathways.md` toctree caption from "User Pathways" to "Find Your Path" to match the navbar label - Removed circular toctree references from `pathway-beginner.md`, `pathway-quickstart.md`, and `pathway-advanced.md` that caused a `RecursionError` during the Sphinx build ## Before / After | Area | Before | After | |---|---|---| | Top navbar | 8 items + "More" dropdown with 2 overflow items | 9 flat items, no dropdown | | Nav item dropdowns | Each item showed child pages on hover | Flat links only | | Pathway page sidebar | 50+ inline cross-reference links | 3 clean pathway links | | Explore Documentation | 9 stacked full-width cards | 3-column grid of 8 cards | | API docs | Separate top-level nav item | Nested under Advanced | ## Preview Co-authored-by: Manus Agent <manus-agent@manus.im>
1 parent 6823b33 commit 28f3cf3

File tree

7 files changed

+1334
-10
lines changed

7 files changed

+1334
-10
lines changed

docs/source/index.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,64 @@
1111

1212
---
1313

14+
## 🗺️ Find Your Path
15+
16+
Not sure where to start? Use the guided pathways to navigate ExecuTorch based on your experience level, goal, and target platform.
17+
18+
::::{grid} 3
19+
:gutter: 3
20+
21+
:::{grid-item-card} 🟢 New to ExecuTorch
22+
:class-header: bg-success text-white
23+
:link: pathway-beginner
24+
:link-type: doc
25+
26+
Step-by-step learning sequence from installation to your first on-device deployment. Includes concept explanations and worked examples.
27+
28+
+++
29+
**Beginner Pathway →**
30+
:::
31+
32+
:::{grid-item-card} 🟡 Get Running Fast
33+
:class-header: bg-warning text-dark
34+
:link: pathway-quickstart
35+
:link-type: doc
36+
37+
Skip the theory — get a model running in 15 minutes. Includes export cheat sheets, backend selection tables, and platform quick starts.
38+
39+
+++
40+
**Quick Start Pathway →**
41+
:::
42+
43+
:::{grid-item-card} 🔴 Production & Advanced
44+
:class-header: bg-danger text-white
45+
:link: pathway-advanced
46+
:link-type: doc
47+
48+
Quantization, custom backends, C++ runtime, LLM deployment, and compiler internals for production-grade systems.
49+
50+
+++
51+
**Advanced Pathway →**
52+
:::
53+
54+
::::
55+
56+
::::{grid} 1
57+
58+
:::{grid-item-card} 🔀 Decision Matrix — Route by Goal, Platform & Model
59+
:link: user-pathways
60+
:link-type: doc
61+
62+
Not sure which pathway fits? The decision matrix routes you by experience level, target platform, model status, and developer role to the exact documentation you need.
63+
64+
+++
65+
**View Decision Matrix →**
66+
:::
67+
68+
::::
69+
70+
---
71+
1472
## 🎯 Wins & Success Stories
1573

1674
::::{grid} 1
@@ -186,6 +244,7 @@ Profile, debug, and inspect your models with comprehensive tooling.
186244
187245
intro-section
188246
quick-start-section
247+
user-pathways
189248
edge-platforms-section
190249
backends-section
191250
llm/working-with-llms

docs/source/intro-section.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,39 @@ Overview, architecture, and core concepts of ExecuTorch.
66

77
ExecuTorch is PyTorch's solution for training and inference on the Edge, providing portability, productivity, and performance for edge computing platforms.
88

9+
---
10+
11+
## New to ExecuTorch? Start Here
12+
13+
::::{grid} 2
14+
:gutter: 2
15+
16+
:::{grid-item-card} 🟢 Beginner Pathway
17+
:link: pathway-beginner
18+
:link-type: doc
19+
20+
A structured, step-by-step learning sequence for engineers new to on-device deployment. Covers concepts, setup, export, and your first device deployment.
21+
:::
22+
23+
:::{grid-item-card} 🔀 Decision Matrix
24+
:link: user-pathways
25+
:link-type: doc
26+
27+
Route yourself to the right documentation based on your experience level, target platform, model status, and developer role.
28+
:::
29+
30+
::::
31+
32+
---
33+
934
## Getting Started with ExecuTorch
1035

1136
New to ExecuTorch? Start with these foundational topics:
1237

13-
- **{doc}`intro-overview`** - High-level overview of ExecuTorch capabilities
14-
- **{doc}`intro-how-it-works`** - Technical overview of the ExecuTorch workflow
15-
- **{doc}`getting-started-architecture`** - System architecture and components
16-
- **{doc}`concepts`** - Core concepts and terminology
38+
- **{doc}`intro-overview`** High-level overview of ExecuTorch capabilities
39+
- **{doc}`intro-how-it-works`** Technical overview of the ExecuTorch workflow
40+
- **{doc}`getting-started-architecture`** System architecture and components
41+
- **{doc}`concepts`** Core concepts and terminology
1742

1843
```{toctree}
1944
:hidden:

0 commit comments

Comments
 (0)