Add deprecation banner to all the docs pages

This commit is contained in:
Evan Simkowitz
2024-12-24 17:45:48 -05:00
parent bc63467c97
commit 046871bf45
23 changed files with 139 additions and 1 deletions
+6
View File
@@ -4,6 +4,12 @@ description: 'Wave lets you customize the look and feel of your terminal'
icon: 'paintbrush'
---
<Warning>
## Wave Terminal Documentation Has Moved
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev).
</Warning>
<img height="200" src="/images/appearance.gif" />
+6
View File
@@ -4,6 +4,12 @@ description: 'Edit files inline and quickly using a rich native UI'
icon: 'code'
---
<Warning>
## Wave Terminal Documentation Has Moved
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev).
</Warning>
<img height="200" src="/images/codeedit.gif" />
Codeedit is built using [Monaco](https://microsoft.github.io/monaco-editor/) (the editor that powers VS Code) and allows you to view and edit files inline using a rich, native UI. It brings to your terminal an unparalleled editing experience with features such as syntax highlighting, code folding, code completion, find and replace, and much more.
+7
View File
@@ -3,6 +3,13 @@ title: 'Connections'
description: 'Run commands on remote machines'
icon: 'map'
---
<Warning>
## Wave Terminal Documentation Has Moved
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev).
</Warning>
## Connections
Wave enhances SSH by offering connections that stay alive across sessions, maintaining your environment and history, unlike traditional SSH that might disconnect and lacks universal command history. Setting up a Wave connection creates a resilient virtual SSH connection, preserving your session details and command logs.
+6
View File
@@ -4,6 +4,12 @@ description: 'View various file types directly in the terminal'
icon: 'file-magnifying-glass'
---
<Warning>
## Wave Terminal Documentation Has Moved
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev).
</Warning>
## What Are File Viewer Plugins?
File viewer plugins are file integrations that allow you to render various file types inline, directly within the terminal. These plugins provide a convenient way to view and interact with different file formats without the need to switch to external applications.
+6
View File
@@ -4,6 +4,12 @@ description: 'Make the most of persistent, context rich history'
icon: 'scroll'
---
<Warning>
## Wave Terminal Documentation Has Moved
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev).
</Warning>
## Introduction
Navigating your command history efficiently is crucial for productivity in any terminal environment. Wave's advanced history features allow you to seamlessly access and manage your past commands not just within the current session but across all workspaces and devices.
+6
View File
@@ -4,6 +4,12 @@ description: 'Edit markdown directly in your terminal'
icon: 'text-size'
---
<Warning>
## Wave Terminal Documentation Has Moved
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev).
</Warning>
Quickly edit code on a local or remote machine with the `codeedit` command
### Example
+6
View File
@@ -4,6 +4,12 @@ description: 'Import your local SSH Configuration'
icon: 'file-import'
---
<Warning>
## Wave Terminal Documentation Has Moved
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev).
</Warning>
## How To Use
You have the ability to import your SSH Configuration in two ways.
- The `remote:parse` command which takes no arguments
+6
View File
@@ -3,6 +3,12 @@ title: 'Generic (Bring Your Own)'
description: 'Get up and running with your own LLM provider'
---
<Warning>
## Wave Terminal Documentation Has Moved
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev).
</Warning>
Wave AI supports the integration of any LLM provider that uses the [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat). This feature allows you to bring your own compatible LLM provider and seamlessly integrate it into your workflow.
While we strive to test and include as many LLM providers as possible, we simply cannot add them all. This is where the ability to add your own, custom LLM comes in — it allows you to configure your own LLM provider with just a couple of simple changes, even if it's not officially listed as supported by Wave AI.
+6
View File
@@ -3,6 +3,12 @@ title: 'llama.cpp'
description: 'Get llama.cpp up and running in Wave AI'
---
<Warning>
## Wave Terminal Documentation Has Moved
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev).
</Warning>
[llama.cpp](https://github.com/ggerganov/llama.cpp) is an open-source project that enables efficient inference of Meta's LLaMA and other compatible models using pure C/C++, with the main goal of enabling LLM inference with minimal setup and state-of-the-art performance on a wide variety of hardware. It offers optimizations for various architectures, supports integer quantization for faster inference and reduced memory usage, and includes custom CUDA kernels, Vulkan, SYCL, and OpenCL backend support.
Wave specifically supports the [llama.cpp HTTP Server](https://github.com/ggerganov/llama.cpp/tree/master/examples/server#llamacpp-http-server), which makes the models available locally to run from other applications like Wave.
+6
View File
@@ -3,6 +3,12 @@ title: 'LM Studio'
description: 'Get LM Studio up and running in Wave AI'
---
<Warning>
## Wave Terminal Documentation Has Moved
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev).
</Warning>
[LM Studio](https://lmstudio.ai/) is a desktop application that allows users to discover, download, and run Large Language Models (LLMs) offline on their personal computers. It supports ggml-compatible models from Hugging Face, including Llama, MPT, and StarCoder. LM Studio provides a user-friendly Chat UI for engaging with the models and an OpenAI-compatible local server for seamless integration with other tools and applications.
Wave specifically supports the [LM Studio Server](https://lmstudio.ai/docs/local-server), which makes the models available locally to run from other applications like Wave.
+6
View File
@@ -3,6 +3,12 @@ title: 'LocalAI'
description: 'Get LocalAI up and running in Wave AI'
---
<Warning>
## Wave Terminal Documentation Has Moved
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev).
</Warning>
[LocalAI](https://localai.io/) is a free, open-source alternative to OpenAI that allows users to run large language models (LLMs), generate images, audio, and more locally or on-premises using consumer-grade hardware. It acts as a drop-in replacement REST API compatible with OpenAI API specifications, enabling users to perform local inferencing. LocalAI supports multiple model families and architectures without requiring a GPU, giving users the power and flexibility to leverage AI while maintaining full control over their data and infrastructure.
**Note:** At the moment, Wave's integration with LocalAI only supports their LLM features. Image generation, audio processing, speech to text, and other capabilities are not yet available but may be added in future updates.
+6
View File
@@ -3,6 +3,12 @@ title: 'Ollama'
description: 'Get Ollama up and running in Wave AI'
---
<Warning>
## Wave Terminal Documentation Has Moved
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev).
</Warning>
[Ollama](https://ollama.com/) is an open-source language model that offers a powerful and flexible alternative to proprietary LLMs, allowing you to run the model locally or on your own server infrastructure. Ollama provides high-quality language generation and understanding capabilities while giving you full control over your data and privacy.
<Tip>
+6
View File
@@ -3,6 +3,12 @@ title: 'OpenAI'
description: 'Get up and running with a different model in OpenAI'
---
<Warning>
## Wave Terminal Documentation Has Moved
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev).
</Warning>
By default, Wave AI proxies your requests through our cloud servers to OpenAI using the _gpt-3.5-turbo_ model. However, users can use their own _API key_ and _model_ for additional flexibility, privacy, and to bypass our current rate limit of 200 requests per day to OpenAI, which was implemented to prevent abuse.
<Tip>
+6
View File
@@ -4,6 +4,12 @@ description: 'Talk to ChatGPT in the terminal'
icon: 'robot'
---
<Warning>
## Wave Terminal Documentation Has Moved
As of September 2024, this version of Wave Terminal is deprecated. To learn more about our new version (>=v0.8.0), check out [www.waveterm.dev](https://www.waveterm.dev). To find documentation for our new version, check out [docs.waveterm.dev](https://docs.waveterm.dev).
</Warning>
Wave AI is our native ChatGPT integration that allows you to ask questions and receive answers directly from your terminal. This feature streamlines your workflow by providing AI assistance without the need to switch between multiple tools or applications.
Wave AI also supports the use of third party LLM providers, allowing you to tailor your AI experience to your specific needs and concerns, whether they're related to privacy, ethics, or accessing the latest technologies. See the [Third-Party LLM Support](#third-party-llm-support-byollm) section for a full list of supported LLM providers.