Skip to content

Commit

Permalink
docs: end-user: add browser page in core-concepts
Browse files Browse the repository at this point in the history
  • Loading branch information
htessaro committed Jan 2, 2024
1 parent 84d8065 commit ece3dc6
Show file tree
Hide file tree
Showing 10 changed files with 69 additions and 4 deletions.
3 changes: 2 additions & 1 deletion .github/styles/Vocab/docs/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ Netlify
KPIs
Heitor
branch_name
subpages
subpages
Watchlist
2 changes: 1 addition & 1 deletion .vale.ini
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
StylesPath = .github/styles
MinAlertLevel = error
MinAlertLevel = warning

Vocab = docs

Expand Down
64 changes: 64 additions & 0 deletions visual-kpi-docs/docs/end-user/core-concepts/browser.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
---
id: browser
title: Browser
slug: end-user/core-concepts/browser
description: Presents the basic browsing concepts in Transpara's Visual KPI Software.
tags: ['core-concepts', 'browser', 'quick-start', 'end-user', 'navigation']
---

import StylizedImage from '@site/src/components/StylizedImage/StylizedImage';

To start navigating your Visual KPI, access the URL provided by your admin. The website's landing page is Dashboard, and you can return anytime by clicking on the Dashboard icon or the Visual KPI icon. You typically customize this page to display the most critical KPIs for your daily operation on this page. You can perform the customization, or you can ask it to the Designer.

## Main sidebar
At the left sidebar, you find icons to access the main functionalities of Visual KPI, the Dashboard homepage, Groups, the Share function, and the Help button.

- **Group**: The group section is like a PC folder, which can contain other groups, KPIs, Charts, and Tables mixed together.

<StylizedImage
imgURL="img/docs/end-user/core-concepts/browser/group-illustration.png"
alt="Group illustration"
/>

- **KPIs**: When you select the KPIs icon, Visual KPI presents a list of your KPIs. You can sort them by clicking the arrows beside each header. The default is the list view, but you can change it by clicking on the icons on the bar above the KPIs. Click on any KPI to see all the detailed information regarding that KPI.

<StylizedImage
imgURL="img/docs/end-user/core-concepts/browser/kpi-illustration.png"
alt="KPI illustration"
/>

- **Charts**: Select the Charts icon to visualize your data and open any Chart in the list to see its details in the data panel.

<StylizedImage
imgURL="img/docs/end-user/core-concepts/browser/charts-illustration.png"
alt="Charts illustration"
/>

- **Tables**: You can access all the Tables related to your Groups, an optional configuration on the Tables icon. With Tables, you can set maintenance logs, shift reports, error lists, or other relevant tabular data to your Groups.
[add image: tables-illustration]

## Quick start tools

The quick start tools enhance your navigation experience by simplifying your interaction. They provide shortcuts to frequently used actions. Below, you find the list of options available:

1. **Home icon**: Click the Home icon to return to the top level of the current Group.

2. **Breadcrumbs**: Breadcrumbs show you where you are in the Group or object hierarchy as you navigate Visual KPI. You can click in each level to go to that specific page. (add example based on image)

3. **Expand and collapse KPI full screen**: Use the full-screen icon to hide the Visual KPI navigation bar and make your KPI or list full screen. When you want to return to the standard view, click the icon again to collapse the full screen.

4. **Hide and show menu**: The Hide Menu icon collapses the tools menu above groups and objects, while the Show Menu icon shows the tools menu.

5. **Profiles**: Click the Profile icon under your company logo to see the profiles shared with you. You can create as many as you like, creating a custom view for different access levels, such as Plant Manager, Supervisor, and Operator.

6. **Watchlist**: Your Watchlist appears in the top bar of your Visual KPI site as a number with an eye icon. You add KPIs to your Watchlist like you add favorites to your bookmarks bar in your browser so the Visual KPI can track the KPIs and alert you when any of those are in alert condition. The number tells you how many of your watched items are in alert condition.

7. **Time stamp**: Shows the last time that the KPIs were updated.

<StylizedImage
imgURL="img/docs/end-user/core-concepts/browser/quickstart.png"
alt="Quickstart tools"
/>

## What's next?
Check out our article [Navigating Groups (Responsive)](end-user/core-concepts/responsive) to learn the benefits of responsive Visual KPI software.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Transpara system is an easy-to-use software that unifies all kinds of data into

## Main concepts

- **Browser**: End-users don't need to install software since the system is accessed through a web browser. You can use it with any operational system on your laptop, mobile phone, or big screens across your plant. Anything that can run a web browser can be used to leverage Visual KPIs.
- **[Browser](./core-concepts/browser)**: End-users don't need to install software since the system is accessed through a web browser. You can use it with any operational system on your laptop, mobile phone, or big screens across your plant. Anything that can run a web browser can be used to leverage Visual KPIs.
You can create as many profiles as needed, selecting and editing the groups, dashboards, visualizations, and alerts for each one. This flexibility allows the user to build its ideal Visual KPI to improve their own experience.

- **Responsive**: Transpara system prioritizes user experience by adapting its interface and functionality to suit different devices, ensuring accessibility and usability regardless of the platform. You can run it on any screen size. You don't need to worry about screen configurations to present your KPIs.
Expand Down
2 changes: 1 addition & 1 deletion visual-kpi-docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ const sidebars = {
id: 'end-user/core-concepts/core-concepts',
},
items: [
'viewers/alerts'
'end-user/core-concepts/browser',
],
},

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ece3dc6

Please sign in to comment.