From a9580bae6b511259bba992a90f265997ccea480d Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 12 Sep 2024 16:16:25 +0300 Subject: [PATCH] Minor docs fixups [skip ci] --- README.md | 4 ++-- docs/features.md | 16 +++++++++++----- 2 files changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 57e8ace..893b651 100644 --- a/README.md +++ b/README.md @@ -19,8 +19,8 @@ It's influenced by [chaz](https://github.com/arcuru/chaz), but does **not** use - [đŸ’Ŧ text-generation](./docs/features.md#-text-generation): communicating with you via text - [đŸĻģ speech-to-text](./docs/features.md#-speech-to-text): turning your voice messages into text - - [đŸ—Ŗī¸ text-to-speech](./docs/features.md#ī¸-text-to-speech): turning bot or users text messages into voice messages - - [🖌ī¸ image-generation](./docs/features.md#-image-generation): generating images based on instructions + - [đŸ—Ŗī¸ text-to-speech](./docs/features.md#%EF%B8%8F-text-to-speech): turning bot or users text messages into voice messages + - [🖌ī¸ image-generation](./docs/features.md#%EF%B8%8F-image-generation): generating images based on instructions - đŸĒ„ Supports [seamless voice interaction](./docs/features.md#seamless-voice-interaction) (turning user voice messages into text, answering in text, then turning that text back into voice) diff --git a/docs/features.md b/docs/features.md index f39ca39..657bd4d 100644 --- a/docs/features.md +++ b/docs/features.md @@ -10,8 +10,8 @@ The bot supports the following use-purposes: - [đŸ’Ŧ text-generation](#-text-generation): communicating with you via text - [đŸĻģ speech-to-text](#-speech-to-text): turning your voice messages into text -- [đŸ—Ŗī¸ text-to-speech](#ī¸-text-to-speech): turning bot or users text messages into voice messages -- [🖌ī¸ image-generation](#-image-generation): generating images based on instructions +- [đŸ—Ŗī¸ text-to-speech](#%EF%B8%8F-text-to-speech): turning bot or users text messages into voice messages +- [🖌ī¸ image-generation](#%EF%B8%8F-image-generation): generating images based on instructions In a given room, each different purpose can be served by a different [☁ī¸ provider](./providers.md) and model. This combination of provider and model configuration is called an [🤖 agent](./agents.md). Each purpose can be served by a different **handler** agent. @@ -32,7 +32,7 @@ A few other features (like [đŸ—Ŗī¸ Text-to-Speech](#ī¸-text-to-speech) and [ You may also wish to see: -- [🛠ī¸ Configuration / đŸ’Ŧ Text Generation](./configuration/README.md#-text-generation) for configuration options related to Text Generation +- [🛠ī¸ Configuration / đŸ’Ŧ Text Generation](./configuration/text-generation.md) for configuration options related to Text Generation - [📖 Usage / đŸ’Ŧ Text Generation](./usage.md#-text-generation) section for more details on how to use the bot for Text Generation in a room @@ -48,7 +48,9 @@ By default, the bot **doesn't** perform text-to-speech. It can be configured for Another use-case is to have the bot operate in [Text-to-Speech-only mode](#text-to-speech-only-mode). -- [🛠ī¸ Configuration / đŸ—Ŗī¸ Text-to-Speech](./configuration/README.md#-text-to-speech) for configuration options related to Text-to-Speech +You may also wish to see: + +- [🛠ī¸ Configuration / đŸ—Ŗī¸ Text-to-Speech](./configuration/text-to-speech.md) for configuration options related to Text-to-Speech - [📖 Usage / đŸ—Ŗī¸ Text-to-Speech](./usage.md#-text-to-speech) section for more details on how to use the bot for Text-to-Speech in a room @@ -77,6 +79,10 @@ The default flow is shown in the screenshot above: your voice messages are trans You may also configure the bot for [Seamless voice interaction](#seamless-voice-interaction) or [Transcribe-only mode](#transcribe-only-mode), etc. +You may also wish to see: + +- [🛠ī¸ Configuration / đŸĻģ Speech-to-Text](./configuration/speech-to-text.md) for configuration options related to Speech-to-Text +- [📖 Usage / đŸĻģ Speech-to-Text](./usage.md#-speech-to-text) section for more details on how to use the bot for Speech-to-Text in a room #### Seamless voice interaction @@ -121,7 +127,7 @@ See a [đŸ–ŧī¸ Screenshot of the Image Generation feature](./screenshots/image-g You may also wish to see: -- [🛠ī¸ Configuration / 🖌ī¸ Image Generation](./configuration/README.md#-image-generation) for configuration options related to Image Generation +- [🛠ī¸ Configuration / 🖌ī¸ Image Generation](./configuration/image-generation.md) for configuration options related to Image Generation - [📖 Usage / 🖌ī¸ Image Generation](./usage.md#-image-generation) section for more details on how to use the bot for Image Generation in a room - [đŸĢĩ Sticker Generation](#-sticker-generation) - a special case of Image Generation