Skip to content

Commit 9a01798

Browse files
authored
Enhance DATA_PIPELINE.md with table of contents
Updated the documentation for the data pipeline to include a table of contents and improved section headings.
1 parent 1d7a9cf commit 9a01798

1 file changed

Lines changed: 23 additions & 4 deletions

File tree

src/DATA_PIPELINE.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,25 @@ Last updated: 2025-11-24
1111

1212
> This automation handles the complete data pipeline setup for the Azure AI Shopping application.
1313
14+
15+
<details>
16+
<summary><b>Table of Content</b> (Click to expand)</summary>
17+
18+
- [Usage](#usage)
19+
- [Data Files](#data-files)
20+
- [Scripts](#scripts)
21+
- [Troubleshooting](#troubleshooting)
22+
- [Configuration](#configuration)
23+
- [Environment Variable Reference](#environment-variable-reference)
24+
- [Verification](#verification)
25+
- [Check Cosmos DB](#check-cosmos-db)
26+
- [Check Search Index](#check-search-index)
27+
- [Query Search Index](#query-search-index)
28+
- [Next Steps](#next-steps)
29+
30+
</details>
31+
32+
1433
> [!NOTE]
1534
> What It Does:
1635
> The data pipeline automation performs the following tasks:
@@ -202,7 +221,7 @@ AZURE_OPENAI_API_KEY=...
202221
AZURE_OPENAI_EMBEDDING_DEPLOYMENT=text-embedding-3-small
203222
```
204223

205-
### Environment Variable Reference
224+
## Environment Variable Reference
206225

207226
| Variable | Default | Description |
208227
|----------------------------|---------|--------------------------------------------------------|
@@ -217,7 +236,7 @@ AZURE_OPENAI_EMBEDDING_DEPLOYMENT=text-embedding-3-small
217236

218237
> After running the pipeline, verify data was imported:
219238
220-
### Check Cosmos DB
239+
## Check Cosmos DB
221240
```powershell
222241
az cosmosdb sql container show \
223242
--account-name <cosmos-account> \
@@ -226,15 +245,15 @@ az cosmosdb sql container show \
226245
--resource-group <rg-name>
227246
```
228247

229-
### Check Search Index
248+
## Check Search Index
230249
```powershell
231250
az search index show \
232251
--index-name products-index \
233252
--service-name <search-service> \
234253
--resource-group <rg-name>
235254
```
236255

237-
### Query Search Index
256+
## Query Search Index
238257
```powershell
239258
az search index show-statistics \
240259
--index-name products-index \

0 commit comments

Comments
 (0)