Skip to content

Commit f5b0ea3

Browse files
authored
docs(menu): consistency, wording fixes (#1363)
* docs(menu): consistency, wording fixes Signed-off-by: Alex C-G <alexcg@outlook.com> * docs(intro): remove redundancy in title Signed-off-by: Alex C-G <alexcg@outlook.com> --------- Signed-off-by: Alex C-G <alexcg@outlook.com>
1 parent bd41ce6 commit f5b0ea3

7 files changed

Lines changed: 11 additions & 11 deletions

File tree

docs/how_to/audio2text.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Creating an Audio to Text App with Jina and DocArray V2
1+
# Create an audio to text app with Jina and DocArray V2
22

3-
This is how you can build an Audio to Text app using Jina, Docarray and Whisper
3+
This is how you can build an Audio to Text app using Jina, DocArray and Whisper.
44

55
We will use:
66

7-
* DocarrayV2: Helps us to load and preprocess multimodal data such as image, text and audio in our case
7+
* DocArray V2: Helps us to load and preprocess multimodal data such as image, text and audio in our case
88
* Jina: Helps us serve the model quickly and create a client
99

1010
First let's install requirements
@@ -76,4 +76,4 @@ with Deployment(
7676
print(docs[0].text)
7777
```
7878

79-
And we get the transcribed result!
79+
And we get the transcribed result!

docs/how_to/multimodal_training_and_serving.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ jupyter:
1212
name: python3
1313
---
1414

15-
# Multi-Modal Deep learning with DocList
15+
# Multimodal deep learning with DocList
1616

1717
DocList is a library for representing, sending, and storing multi-modal data that can be used for a variety of different
1818
use cases.

docs/how_to/optimize_performance_with_id_generation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# How to optimize performance
1+
# Optimize performance
22

33
### `BaseDoc`'s id
44

docs/user_guide/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# User Guide - Introduction
1+
# Introduction
22

33
This user guide shows you how to use `DocArray` with most of its features.
44

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# Sending
1+
# Sending data
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# Storing
1+
# Storing data

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ plugins:
7676

7777
nav:
7878
- Home: README.md
79-
- Tutorial - User Guide:
79+
- Tutorial/User Guide:
8080
- user_guide/intro.md
81-
- Representing:
81+
- Representing data:
8282
- user_guide/representing/first_step.md
8383
- user_guide/representing/array.md
8484
- user_guide/sending/first_step.md

0 commit comments

Comments
 (0)