Minor docs fixups

[skip ci]
This commit is contained in:
Slavi Pantaleev
2024-09-12 16:16:25 +03:00
parent 4a3d2082cb
commit a9580bae6b
2 changed files with 13 additions and 7 deletions

View File

@@ -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 - [💬 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 - [🦻 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 - [🗣️ 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#-image-generation): generating images based on instructions - [🖌️ 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) - 🪄 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)

View File

@@ -10,8 +10,8 @@ The bot supports the following use-purposes:
- [💬 text-generation](#-text-generation): communicating with you via text - [💬 text-generation](#-text-generation): communicating with you via text
- [🦻 speech-to-text](#-speech-to-text): turning your voice messages into 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 - [🗣️ text-to-speech](#%EF%B8%8F-text-to-speech): turning bot or users text messages into voice messages
- [🖌️ image-generation](#-image-generation): generating images based on instructions - [🖌️ 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. 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: 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 - [📖 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). 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 - [📖 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 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 #### Seamless voice interaction
@@ -121,7 +127,7 @@ See a [🖼️ Screenshot of the Image Generation feature](./screenshots/image-g
You may also wish to see: 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 - [📖 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 - [🫵 Sticker Generation](#-sticker-generation) - a special case of Image Generation