Skip to content

Commit a513d6f

Browse files
committed
improved documentation
1 parent 1e9b74a commit a513d6f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

test2text/pages/documentation.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,37 +14,37 @@ def show_documentation():
1414
1515
## Application Pages Overview
1616
17-
### 1. **About application**
17+
### :gray-badge[:material/info: About application]
1818
- **Description:** This page contains the user guide, a description of all pages, and instructions for working with the application.
1919
- **How to use:** Simply read the description to understand the purpose of the application.
2020
21-
### 2. **Annotations**
21+
### :gray-badge[:material/database_upload: Annotations]
2222
- **Description:** Work with annotations that link requirements and test cases.
2323
- **How to use:**
2424
- View existing annotations.
2525
- Add new annotations to link requirements and test cases.
2626
27-
### 3. **Requirements**
27+
### :gray-badge[:material/database_upload: Requirements]
2828
- **Description:** View selected requirements.
2929
- **How to use:**
3030
- Browse the list of requirements.
3131
- Add new requirements.
3232
- Link requirements with annotations and test cases.
3333
34-
### 4. **Reports**
34+
### :gray-badge[:material/publish: Reports]
3535
- **Description:** Generate reports on test cases, requirements, and their relationships.
3636
- **How to use:**
3737
- Select the desired report type (e.g., by test case or by requirement).
3838
- Use filters to refine the report.
3939
- Analyze selected requirements or test cases by showed and plotted distances.
4040
41-
### 5. **Cache distances**
41+
### :gray-badge[:material/cached: Controls]
4242
- **Description:** Update distances by embeddings (vector representations) for intelligent matching of requirements and annotations.
4343
- **How to use:**
4444
- Enter a search query or embedding.
4545
- Get relevant results based on vector search.
4646
47-
### 6. **Visualize vectors**
47+
### :gray-badge[:material/dataset: Visualize vectors]
4848
- **Description:** Visualise distances by embeddings (vector representations) of requirements and annotations.
4949
- **How to use:**
5050
- Run script that will get all the data from database and will plot it to 2d and 3d graphics.

0 commit comments

Comments
 (0)