Skip to content

Commit e9e3631

Browse files
authored
updates for docs index page (#1258)
1 parent 8e15c28 commit e9e3631

4 files changed

Lines changed: 65 additions & 21 deletions

File tree

docs/docs/index.mdx

Lines changed: 51 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,36 +12,68 @@ import { Card, CardGroup } from "@site/src/components/card.tsx";
1212

1313
Wave is an [open-source](https://github.com/wavetermdev/waveterm) terminal that adds the ability to launch graphical widgets, controlled and integrated directly with the CLI. We support MacOS, Linux, and Windows ([Downloads](https://waveterm.dev/download)).
1414

15+
Wave isn't just another terminal emulator; it's a rethink on how terminals are built. For too long there has been a disconnect between the CLI and the web. If you want fast, keyboard-accessible, easy-to-write applications, you use the CLI, but if you want graphical interfaces, native widgets, copy/paste, scrolling, variable font sizes, then you'd have to turn to the web. Wave's goal is to bridge that gap.
16+
17+
![Wave Screenshot](/img/wave-screenshot.webp)
18+
19+
<CardGroup>
20+
<Card
21+
href="./customization"
22+
icon="fa-file-magnifying-glass"
23+
title="Customization"
24+
description="Set up tabs and terminals to match your workflow needs."
25+
/>
26+
<Card
27+
href="./keybindings"
28+
icon="fa-file-magnifying-glass"
29+
title="Key Bindings"
30+
description="Boost efficiency with keyboard shortcuts for faster navigation."
31+
/>
32+
<Card
33+
href="./layout"
34+
icon="fa-file-magnifying-glass"
35+
title="Layout"
36+
description="Organize your workspace using our layout system."
37+
/>
38+
<Card
39+
href="./connections"
40+
icon="fa-file-magnifying-glass"
41+
title="Remote Connections"
42+
description="Quickly SSH or connect to remote machines in one step."
43+
/>
44+
<Card
45+
href="./widgets"
46+
icon="fa-file-magnifying-glass"
47+
title="Widgets"
48+
description="Explore built-in tools to extend your terminal’s functionality."
49+
/>
50+
<Card
51+
href="./wsh-command"
52+
icon="fa-file-magnifying-glass"
53+
title="wsh Command"
54+
description="Control Wave and launch widgets directly from the command line."
55+
/>
56+
</CardGroup>
57+
58+
<div style={{ marginBottom: 30 }} />
59+
1560
:::info
1661

17-
**These docs are incomplete**, but we're working on them. If you have a question, please feel free to ask us in [Discord](https://discord.gg/XfvZ334gwU). If you'd like to file a bug/enchancement, please
18-
use [Github Issues](https://github.com/wavetermdev/waveterm/issues). These docs are also open-source and we do accept PRs for docs [here](https://github.com/wavetermdev/waveterm/blob/main/docs). You can click the "Edit this page" link at the bottom of the page to get taken directly to the editor page for that document in GitHub.
62+
If you have a question, please feel free to ask us in [Discord](https://discord.gg/XfvZ334gwU). If you'd like to file a bug/enchancement, please use [Github Issues](https://github.com/wavetermdev/waveterm/issues). These docs are also open-source and we do accept PRs for docs [here](https://github.com/wavetermdev/waveterm/blob/main/docs). You can click the "Edit this page" link at the bottom of the page to get taken directly to the editor page for that document in GitHub.
1963

2064
:::
2165

22-
References:
66+
<div class="reference-links">
67+
68+
Other References:
2369

24-
- [Widgets](./widgets)
2570
- [Configuration](./config)
26-
- [Key Bindings](./keybindings)
27-
- [wsh command](./wsh)
28-
- [Connections](./connections)
29-
- [Tab Layout System](./layout)
3071
- [Custom Widgets](./customwidgets)
3172
- [Telemetry](./telemetry)
3273
- [FAQ](./faq)
74+
- [Release Notes](./releasenotes)
3375

34-
<!--
35-
## Features
36-
37-
<CardGroup>
38-
<Card href="features/preview" icon="fa-file-magnifying-glass" title="File Previews" description="Preview widgets let you view markdown, images, video, CSVs, and more inline." />
39-
<Card href="features/remotes" icon="fa-server" title="Reliable Remote Connections" description="Automatic reconnection, remote file previews, and more." />
40-
<Card href="features/ai" icon="fa-sparkles" title="Integrated AI" description="Inline AI Chat Windows hooked up to any LLM (local or remote)." />
41-
<Card href="features/browser" icon="fa-globe" title="Inline Web Browser" description="Access online content without switching context." />
42-
<Card href="features/charts" icon="fa-chart-simple" title="Data Visualization" description="Create graphs of system stats or custom data piped directly from CLI programs." />
43-
</CardGroup>
44-
-->
76+
</div>
4577

4678
## Links
4779

docs/src/components/card.css

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,24 @@
55
gap: 1rem;
66
}
77

8-
@media (max-width: 650px) {
8+
@media (max-width: 450px) {
99
.card-group {
1010
grid-template-columns: 1fr;
1111
}
1212
}
1313

14-
@media (996px < width <= 1170px) {
14+
@media (min-width: 451px) and (max-width: 995px) {
1515
.card-group {
1616
grid-template-columns: repeat(2, 1fr);
1717
}
1818
}
1919

20+
@media (min-width: 996px) {
21+
.card-group {
22+
grid-template-columns: repeat(3, 1fr);
23+
}
24+
}
25+
2026
.card {
2127
display: grid;
2228
grid-template-columns: 1.5rem 1rem 1fr;

docs/src/css/custom.css

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,12 @@ body .markdown h2 {
3232
--ifm-h2-font-size: 1.75rem;
3333
}
3434

35+
@media (min-width: 996px) {
36+
.reference-links {
37+
display: none;
38+
}
39+
}
40+
3541
/* Adds extra margin between last navbar item and the dark mode toggle. */
3642
.navbar__items--right .navbar__item:last-of-type {
3743
margin-right: 4px;
105 KB
Loading

0 commit comments

Comments
 (0)