Skip to content

Commit c40ac39

Browse files
authored
docs: automated update - 2026-W18 (#35)
1 parent cb0a1e0 commit c40ac39

3 files changed

Lines changed: 61 additions & 16 deletions

File tree

18 KB
Loading
78.6 KB
Loading

‎docs/user-guide/studio-app-ui-overview.mdx‎

Lines changed: 61 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,53 @@ import { HelpCircle, Info, Delete, Maximize2, PlusSquare, Copy, ListRestart } fr
99

1010
# TangleML Studio UI Guide
1111

12-
TangleML Studio provides a comprehensive web-based interface for building, managing, and running machine learning pipelines. This guide walks you through the main areas of the application: Home screen, Editor, Pipeline Run, and Settings.
12+
TangleML Studio provides a comprehensive web-based interface for building, managing, and running machine learning pipelines. This guide walks you through the main areas of the application: Dashboard, Editor, Pipeline Run, and Settings.
1313

14-
## Home screen
14+
## Dashboard
1515

16-
The home screen serves as your dashboard for managing pipelines and monitoring runs across your TangleML instance.
16+
The Dashboard is your home base for navigating pipelines, runs, and components across your TangleML instance. A persistent sidebar on the left lets you switch between views without leaving the dashboard layout.
1717

18-
### All runs
18+
### Sidebar navigation
1919

20-
The **All Runs** section displays a comprehensive list of all pipeline runs on your TangleML instance.
20+
The dashboard sidebar contains the following entries:
21+
22+
- **My Dashboard** — overview of favorites, recently viewed items, recently used components, and your runs.
23+
- **My Pipelines** — your draft pipelines, with a preview of favorited pipelines on top.
24+
- **All Runs** — every pipeline run on your TangleML instance, with a filter bar for narrowing results.
25+
- **Components** — a searchable browser for User Components, the Standard Library, and Published Components.
26+
- **Favorites** — every pipeline and run you've starred, in a single grid with search and pagination.
27+
- **Recently Viewed** — the pipelines and runs you've most recently opened.
28+
29+
The bottom of the sidebar provides quick links to the documentation, the Settings page, and the application footer (About, Give feedback, Privacy policy, version).
30+
31+
### My Dashboard
32+
33+
The **My Dashboard** view is the landing page when you visit the dashboard. It surfaces the things you're most likely to want to come back to:
34+
35+
- **Favorites** — up to five most recently starred pipelines or runs. Hover a row to reveal an inline **X** button that removes the item from favorites without leaving the page.
36+
- **Recently Viewed** — up to five most recently opened pipelines or runs, with a relative timestamp showing when you last viewed each one.
37+
- **Recently Used Components** — up to five most recently opened components from the Components view.
38+
- **My Runs** — a compact list of up to ten runs you created, ordered by most recent first.
39+
40+
Each preview block has a **View all →** link in the heading that takes you to the full view for that section.
41+
42+
### My Pipelines
43+
44+
The **My Pipelines** view manages your draft pipelines stored locally in browser storage.
45+
46+
<img src={require("./assets/HomeScreen_MyPipelines.png").default} alt="My Pipelines" style={{width: "100%", borderRadius: "6px"}} />
47+
48+
- **Favorite Pipelines preview**: When you have one or more favorited pipelines, a preview block appears at the top of the view with up to five of them. The block is hidden automatically when you have no favorited pipelines so it doesn't take up space.
49+
- **Local storage**: All draft pipelines are stored in your browser's local storage. For more on local vs shared storage, see [Pipelines Persistence](/docs/getting-started/pipelines-persistence).
50+
- **Filter and search**: Use the filter bar to search pipelines by name. Matching text is highlighted in search results. Sort by name or last modified date.
51+
- **Tags**: Pipelines with tags display them directly in the list row for quick identification.
52+
- **Bulk operations**: Select multiple pipelines using checkboxes for bulk delete operations.
53+
- **Run history**: Pipelines with existing runs display a "runs" popover showing execution history.
54+
- **Quick actions**: Edit, duplicate, or delete pipelines directly from the list.
55+
56+
### All Runs
57+
58+
The **All Runs** view displays a comprehensive list of all pipeline runs on your TangleML instance.
2159

2260
<img src={require("./assets/HomeScreen_AllRuns.png").default} alt="All Runs" style={{width: "100%", borderRadius: "6px"}} />
2361

@@ -31,18 +69,25 @@ The runs list includes a filter bar with the following controls:
3169
- **Run status**: View the current status of each run (**Running**, **Succeeded**, **Failed**, **Cancelled**).
3270
- **Quick access**: Click on any run to view detailed execution information.
3371

34-
### My Pipelines
72+
### Components
3573

36-
The **My Pipelines** section manages your draft pipelines stored locally in browser storage.
74+
The **Components** view is a two-pane browser for every component available to your TangleML instance:
3775

38-
<img src={require("./assets/HomeScreen_MyPipelines.png").default} alt="My Pipelines" style={{width: "100%", borderRadius: "6px"}} />
76+
- **Left pane**: A collapsible list grouped into **User Components**, **Library Components** (the standard library, organised as a folder tree when you're not searching), and **Published Components** (components published to the connected backend). Use the search box at the top to filter all three groups by name or author.
77+
- **Right pane**: When you select a component, this pane shows its name, author, digest, description, GitHub source links (when available), inputs and outputs, and a sticky source-code viewer with the full YAML definition.
3978

40-
- **Local storage**: All draft pipelines are stored in your browser's local storage. For more on local vs shared storage, see [Pipelines Persistence](/docs/getting-started/pipelines-persistence).
41-
- **Filter and search**: Use the filter bar to search pipelines by name. Matching text is highlighted in search results. Sort by name or last modified date.
42-
- **Tags**: Pipelines with tags display them directly in the list row for quick identification.
43-
- **Bulk operations**: Select multiple pipelines using checkboxes for bulk delete operations.
44-
- **Run history**: Pipelines with existing runs display a "runs" popover showing execution history.
45-
- **Quick actions**: Edit, duplicate, or delete pipelines directly from the list.
79+
The selected component is reflected in the URL, so you can share a link to a specific component with collaborators.
80+
81+
### Favorites
82+
83+
The **Favorites** view shows every pipeline and run you've starred as a card grid. Each card displays the item's type, name, and ID, and reveals an **X** button on hover for removing the item from favorites.
84+
85+
- **Search**: Filter favorites by name or ID. The search field clears search state with the inline **X** button.
86+
- **Pagination**: Favorites are paginated 20 per page, with previous/next controls beneath the grid when there is more than one page.
87+
88+
### Recently Viewed
89+
90+
The **Recently Viewed** view lists the pipelines and runs you've most recently opened, as a card grid with relative timestamps. Items are paginated 20 per page. Components are tracked separately and surface in **Recently Used Components** on My Dashboard, not in this list.
4691

4792
## Editor
4893

@@ -197,7 +242,7 @@ When no Task is selected, the panel shows pipeline-level information:
197242
**Tags:**
198243

199244
- Add up to 10 tags to a pipeline for categorisation and search.
200-
- Click **Add tag** to create a new tag. Tags appear in the pipeline list on the Home screen.
245+
- Click **Add tag** to create a new tag. Tags appear in the pipeline list on **My Pipelines** in the dashboard.
201246
- Click an existing tag to edit or remove it.
202247

203248
**Pipeline inputs/outputs:**
@@ -439,7 +484,7 @@ To use a secret in a task argument, open the argument's dynamic data dropdown an
439484
- **Use descriptions**: Add meaningful descriptions to help others understand your pipeline
440485
- **Use tags**: Tag pipelines with project names or status labels to make them easier to find in the pipeline list
441486
- **Organize components**: Keep your **User Components** library organized by removing unused items
442-
- **Monitor runs**: Check the **All Runs** section to track pipeline performance over time
487+
- **Monitor runs**: Check the **All Runs** view in the dashboard to track pipeline performance over time
443488

444489
## Keyboard shortcuts & hotkeys
445490

0 commit comments

Comments
 (0)