Skip to content
This repository was archived by the owner on Nov 6, 2024. It is now read-only.

Commit 8d46e43

Browse files
committed
update config paths
1 parent c297cd6 commit 8d46e43

File tree

4 files changed

+12
-5
lines changed

4 files changed

+12
-5
lines changed

docs/config.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ use ":" as level separators.
1414
:::info
1515

1616
If you installed Wave pre-v0.9.0 your configuration file will be located at
17-
`~/.waveterm/config/settings.json`.
17+
`~/.waveterm/config/settings.json`. This includes all of the other configuration
18+
files as well: `termthemes.json`, `presets.json`, and `widgets.json`.
1819

1920
:::
2021

@@ -82,7 +83,7 @@ For reference this is the current default configuration (v0.8.8):
8283

8384
### Terminal Theming
8485

85-
User-defined terminal themes are located in `~/.waveterm/config/termthemes.json`. This JSON file is structured as an object, with each sub-key defining a theme.
86+
User-defined terminal themes are located in `~/.config/waveterm/termthemes.json`. This JSON file is structured as an object, with each sub-key defining a theme.
8687
Themes are applied by right-clicking on the terminal's header bar and selecting an entry from the "Themes" sub-menu. Alternatively they can be applied to
8788
the block's metadata key `term:theme`. This uses the JSON key value as the identifier. Note, for best consistency all colors should be of the format "#rrggbb" or "#rrggbbaa" (aa = alpha channel for transparency).
8889

docs/customwidgets.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,8 @@ Wave allows users to create their own widgets to uniquely customize their experi
1010

1111
# Terminal and CLI Widgets
1212

13-
A terminal widget, or CLI widget, is a widget that simply opens a terminal and runs a CLI command. These widgets are managed in the `~/.waveterm/config/widgets.json` file.
13+
A terminal widget, or CLI widget, is a widget that simply opens a terminal and runs a CLI command.
14+
These widgets are managed in the `~/.config/waveterm/widgets.json` file.
1415

1516
## Designing a Widget
1617

docs/faq.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ title: "FAQ"
88

99
### How do I set up my own LLM?
1010

11-
You must manually edit the [config file](./config) located at `~/.waveterm/config/settings.json`.
11+
You must manually edit the [config file](./config) located at `~/.config/waveterm/settings.json`.
1212

1313
| Key Name | Type | Function |
1414
|----------|------|----------|
@@ -36,7 +36,7 @@ Here are the ollma open AI compatibility docs: https://github.com/ollama/ollama/
3636

3737
### How can I connect to Azure AI
3838

39-
You must manually edit the [config file](./config) located at `~/.waveterm/config/settings.json`.
39+
You must manually edit the [config file](./config) located at `~/.config/waveterm/settings.json`.
4040

4141
You'll need to set your `ai:baseurl` to your Azure AI Base URL (do not include query parameters or `api-version`).
4242
You'll also need to set `ai:apitype` to `azure`. You can then set the `ai:model`, and `ai:apitoken` appropriately

sidebars.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,11 @@ const sidebars: SidebarsConfig = {
1717
id: "config",
1818
label: "Configuration",
1919
},
20+
{
21+
type: "doc",
22+
id: "customwidgets",
23+
label: "Custom Widgets",
24+
},
2025
{
2126
type: "doc",
2227
id: "telemetry",

0 commit comments

Comments
 (0)