Skip to content

Commit

Permalink
add faq and release notes (#36)
Browse files Browse the repository at this point in the history
* add faq

* add a releasenotes page
  • Loading branch information
sawka authored Sep 30, 2024
1 parent 69dbb8c commit 4449a8b
Show file tree
Hide file tree
Showing 4 changed files with 98 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/faq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
---
sidebar_position: 7
id: "faq"
title: "FAQ"
---

# FAQ

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

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

| Key Name | Type | Function |
|----------|------|----------|
| ai:baseurl | string | Set the AI Base Url (must be OpenAI compatible) |
| ai:apitoken | string | your AI api token |
| ai:name | string | string to display in the Wave AI block header |
| ai:model | string | model name to pass to API |
| ai:maxtokens | int | max tokens to pass to API |
| ai:timeoutms | int | timeout (in milliseconds) for AI calls |

Here's an example of pointing it to a local Ollama instance. Note that to get the text in the header of the AI block
to update, you'll need to set the "ai:name" key. For ollama, you'll also need to provide something for the
apitoken (even though it is ignored).

Here are the ollma open AI compatibility docs: https://github.com/ollama/ollama/blob/main/docs/openai.md

```json
{
"ai:baseurl": "http://localhost:11434/v1",
"ai:name": "llama3.2",
"ai:model": "llama3.2",
"ai:apitoken": "ollama"
}
```

### How can I see the block numbers?

The block numbers will appear when you hold down Ctrl-Shift (and disappear once you release the key combo).

### How do I make a remote connection?

There is a button in the header. Click the <i className="fa-sharp fa-laptop"/> or <i className="fa-sharp fa-arrow-right-arrow-left"/>
and type the `[user]@[host]` that you wish to connect to.
1 change: 1 addition & 0 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ References:
* [Telemetry](./telemetry)
* [Wsh](./wsh)
* [Widgets](./widgets)
* [FAQ](./faq)

## Features

Expand Down
48 changes: 48 additions & 0 deletions docs/releasenotes.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
id: "releasenotes"
title: "Release Notes"
sidebar_position: 8
---

# Release Notes

### v0.8.5 &mdash; Sep 25, 2024

Hot fix, dowgrade `jotai` library. Upgrading caused a major regression in codeedit which did not allow
users to edit files.

### v0.8.4 &mdash; Sep 25, 2024

* Added a setting `window:disablehardwareacceleration` to disable native hardware acceleration
* New startup model for legacy users given them the option to download the WaveLegacy
* Use WAVETERM_HOME for the home directory consistently

### v0.8.3 &mdash; Sep 25, 2024

More hotfixes for Linux users. We now link against an older version of glibc and use
the zig compiler on linux (the newer version caused us not to run on older distros).
Also fixes a permissions issue when installing via .deb. There is also a new config value
`window:nativetitlebar` which restores the native titlebar on windows/linux.


### v0.8.2 &mdash; Sep 24, 2024

Hot fix, fixes a nasty crash on startup for Linux users (dynamic linking but with netcgo DNS library)

### v0.8.1 &mdash; Sep 23, 2024

Minor cleanup release.

* fix number parsing for certain config file values
* add link to docs site
* add new back button for directory view
* telemetry fixes

### v0.8.0 &mdash; Sep 20, 2024

**Major New Relase of Wave Terminal**

The new build is a fresh start, and a clean break from the current version. As such, your history, settings, and configuration will not be carried over. If you'd like to continue to run the legacy version, you will need to download it separately.


Release Artificats and source code diffs can be found on (Github)[https://github.com/wavetermdev/waveterm].
5 changes: 5 additions & 0 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ const sidebars: SidebarsConfig = {
id: "widgets",
label: "Widgets",
},
{
type: "doc",
id: "faq",
label: "FAQ",
},
],
};

Expand Down

0 comments on commit 4449a8b

Please sign in to comment.