Skip to content

Commit 1d9dec1

Browse files
committed
docs(fern): clarify getting started navigation
Group tutorials under Get Started and label the homepage explore cards so readers can scan learning paths and reference material more quickly.
1 parent 2ef6706 commit 1d9dec1

File tree

3 files changed

+39
-1
lines changed

3 files changed

+39
-1
lines changed

fern/main.css

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -552,6 +552,33 @@ svg.card-icon{
552552
.fern-docs-badge{
553553
border-radius: var(--rounded);
554554
}
555+
556+
.explore-cards .fern-card {
557+
display: flex;
558+
height: 100%;
559+
}
560+
561+
.explore-cards .fern-card > div,
562+
.explore-cards .fern-card > div > div {
563+
display: flex;
564+
flex: 1 1 auto;
565+
flex-direction: column;
566+
width: 100%;
567+
}
568+
569+
.explore-cards .fern-card p {
570+
margin-bottom: 0.75rem;
571+
}
572+
573+
.explore-cards .fern-card .fern-docs-badge {
574+
align-self: flex-start;
575+
margin-top: auto;
576+
}
577+
578+
.explore-cards .fern-card br {
579+
display: none;
580+
}
581+
555582
.fern-page-actions button:hover{
556583
background-color: transparent !important;
557584
}

fern/pages/index.mdx

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,57 +91,67 @@ Refer to the [Quickstart](/get-started/quickstart) for more details.
9191

9292
## Explore
9393

94+
<div className="explore-cards">
9495
<Cards>
9596

9697
<Card title="About OpenShell" href="/about/overview">
9798

9899
Learn about OpenShell and its capabilities.
99100

101+
<Badge intent="tip" minimal outlined>Concept</Badge>
100102
</Card>
101103

102104
<Card title="Quickstart" href="/get-started/quickstart">
103105

104106
Install the CLI and create your first sandbox in two commands.
105107

108+
<Badge intent="tip" minimal outlined>Tutorial</Badge>
106109
</Card>
107110

108111
<Card title="Tutorials" href="/tutorials/index">
109112

110113
Hands-on walkthroughs from first sandbox to custom policies.
111114

115+
<Badge intent="tip" minimal outlined>Concept</Badge>
112116
</Card>
113117

114118
<Card title="Gateways and Sandboxes" href="/sandboxes/manage-gateways">
115119

116120
Deploy gateways, create sandboxes, configure policies, providers, and community images for your AI agents.
117121

122+
<Badge intent="tip" minimal outlined>Concept</Badge>
118123
</Card>
119124

120125
<Card title="Inference Routing" href="/inference/about">
121126

122127
Keep inference traffic private by routing API calls to local or self-hosted backends.
123128

129+
<Badge intent="tip" minimal outlined>Concept</Badge>
124130
</Card>
125131

126132
<Card title="Observability" href="/observability/index">
127133

128134
Understand sandbox logs, access them via CLI and TUI, and export OCSF JSON records.
129135

136+
<Badge intent="tip" minimal outlined>How-To</Badge>
130137
</Card>
131138

132139
<Card title="Reference" href="/reference/default-policy">
133140

134141
Policy schema, environment variables, and system architecture.
135142

143+
<Badge intent="tip" minimal outlined>Reference</Badge>
136144
</Card>
137145

138146
<Card title="Security Best Practices" href="/security/best-practices">
139147

140148
Every configurable security control, its default, and the risk of changing it.
141149

150+
<Badge intent="tip" minimal outlined>Concept</Badge>
142151
</Card>
143152

144153
</Cards>
154+
</div>
145155

146156
---
147157

fern/versions/latest.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,10 @@ navigation:
88
path: ../pages/index.mdx
99
- page: "Quickstart"
1010
path: ../pages/get-started/quickstart.mdx
11+
- folder: ../pages/tutorials
12+
skip-slug: true
1113
- folder: ../pages/about
1214
title: "About NVIDIA OpenShell"
13-
- folder: ../pages/tutorials
1415
- folder: ../pages/sandboxes
1516
- folder: ../pages/inference
1617
title: "Inference Routing"

0 commit comments

Comments
 (0)