Skip to content

Commit 6051e38

Browse files
committed
move get started to user manual
1 parent 421042d commit 6051e38

File tree

20 files changed

+4872
-216
lines changed

20 files changed

+4872
-216
lines changed

content/docs/get-started/_index.md renamed to content/docs/manual/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
weight: 999
3-
title: "Get Started"
3+
title: "User Manual"
44
description: "Start your first BDIViz workflow."
55
icon: "rocket"
66
date: "2025-04-19T13:38:17-04:00"

content/docs/get-started/explore-matches.md renamed to content/docs/manual/explore-matches.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ draft: false
99
toc: true
1010
---
1111

12-
## Overview
12+
## Overview 🔍
1313

1414
After uploading your files, BDIViz launches its main interface, allowing you to visually explore match candidates between your source dataset and the target schema.
1515

1616
---
1717

18-
## Interactive Heatmap
18+
## Interactive Heatmap 🔥
1919

2020
The heatmap is the primary visualization tool in BDIViz. Each cell represents a match candidate between a source attribute (y-axis) and a target attribute (x-axis).
2121

@@ -81,7 +81,7 @@ The top-level filter tabs help narrow your focus:
8181

8282
---
8383

84-
## Filters and Search Controls
84+
## Filters and Search Controls 🔍
8585

8686
Fine-tune the heatmap view using a suite of filters:
8787

@@ -130,7 +130,7 @@ Quickly locate and highlight target attributes by name or keyword.
130130

131131
---
132132

133-
## Lower Panel: Match Details
133+
## Lower Panel: Match Details 🔎
134134

135135
Clicking on any heatmap node reveals deeper insights below:
136136

@@ -163,7 +163,7 @@ Visualizes how different matchers contributed to the candidate match score.
163163

164164
---
165165

166-
## LLM Agent Panel
166+
## LLM Agent Panel 🤖
167167

168168
![agent-panel](./images/agent-panel.png)
169169

@@ -177,7 +177,7 @@ An embedded LLM-powered assistant provides contextual insights:
177177

178178
---
179179

180-
## Whats Next?
180+
## What's Next? 🚀
181181

182182
After reviewing the matches:
183183

content/docs/get-started/export-your-mappings.md renamed to content/docs/manual/export-your-mappings.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ draft: false
99
toc: true
1010
---
1111

12-
## Overview
12+
## Overview 📊
1313

1414
Once your schema matching task is complete, BDIViz enables you to export the validated mappings for use in data integration pipelines, reporting workflows, or system submissions.
1515

1616
![export-matches-gif](./images/export-matches.gif)
1717

1818
---
1919

20-
## How to Export
20+
## How to Export 📤
2121

2222
To begin exporting your results:
2323

@@ -27,7 +27,7 @@ To begin exporting your results:
2727

2828
---
2929

30-
## Export Formats
30+
## Export Formats 📋
3131

3232
BDIViz supports two export options designed for different use cases:
3333

@@ -98,7 +98,7 @@ The JSON export provides a structured record of all mapping operations with deta
9898
{{% /tab %}}
9999
{{< /tabs >}}
100100

101-
## Final Notes
101+
## Final Notes 📝
102102
- Ensure all intended mappings are **accepted** before exporting; rejected and discarded mappings will not be included.
103103
- Use the **Timeline Panel** to review decisions prior to export.
104-
- Both formats can be downloaded directly to your local machine.
104+
- Both formats can be downloaded directly to your local machine.

content/docs/get-started/upload-your-data.md renamed to content/docs/manual/upload-your-data.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ draft: false
99
toc: true
1010
---
1111

12-
## 1. Start a New Matching Task
12+
## 1. Start a New Matching Task 🔄
1313

1414
To begin, click the **"New Matching Task"** button located on the far right of the navigation bar. This will open the upload interface.
1515

@@ -25,7 +25,7 @@ These files are essential for initiating schema matching and visual comparison.
2525

2626
---
2727

28-
## 2. Upload Required Files
28+
## 2. Upload Required Files 📂
2929

3030
### A. Source CSV File (Required)
3131

@@ -93,7 +93,7 @@ Upload a `.json` file that defines metadata and attributes for the target schema
9393
}
9494
```
9595

96-
## 3. Launch the Matching Task
96+
## 3. Launch the Matching Task 🚀
9797

9898
Once all necessary files are uploaded, click the **"Import CSV"** button to start processing.
9999

@@ -104,9 +104,9 @@ The system will:
104104

105105
This step may take several minutes depending on the size of your dataset.
106106

107-
## Next Steps
107+
## What's Next? 🚀
108108
After the task is launched, you will be redirected to the schema matching workspace where you can:
109109

110110
- Review alignment suggestions
111111
- Accept or reject proposed matches
112-
- Explore value mappings and distributions interactively
112+
- Explore value mappings and distributions interactively

content/docs/get-started/user-operation.md renamed to content/docs/manual/user-operation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ draft: false
99
toc: true
1010
---
1111

12-
## Overview
12+
## Overview 🔍
1313

1414
BDIViz provides a streamlined interface for managing match candidates directly within the heatmap view. The **Shortcut Panel**, located at the top-left of the screen, offers essential interactive tools for evaluating and adjusting alignment results.
1515

@@ -19,7 +19,7 @@ These operations allow users to mark candidates as accepted, rejected, or discar
1919

2020
---
2121

22-
## Available Actions
22+
## Available Actions 🎮
2323

2424
The table below summarizes the core user operations available via the Shortcut Panel:
2525

@@ -35,7 +35,7 @@ The table below summarizes the core user operations available via the Shortcut P
3535
3636
---
3737

38-
## Best Practices
38+
## Best Practices 💡
3939

4040
- **Leverage Keyboard Shortcuts**: Speed up match decisions using shortcut buttons or hotkeys (where supported).
4141
- **Work Iteratively**: Use **Undo** and **Redo** freely to experiment and refine decisions without permanent impact.
@@ -47,7 +47,7 @@ The table below summarizes the core user operations available via the Shortcut P
4747

4848
---
4949

50-
## Next Steps
50+
## What's Next? 🚀
5151

5252
After reviewing and operating on match candidates:
5353

public/docs/index.html

Lines changed: 38 additions & 38 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)