Skip to content

Update Dashboard Navigation guide #202

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 49 additions & 34 deletions docs/home/platform/dashboard/navigate/index.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
slug: /platform/dashboard/get-started/explore
title: Navigate
description: Explore your SignalWire Space.
title: Sidebar navigation
description: Learn to navigate the SignalWire Dashboard, its sidebar, and its toolbar.
x-custom:
ported_from_readme: true
tags:
Expand All @@ -10,9 +10,9 @@ x-custom:

import NewLegacy from '/docs/_common/dashboard/_ui-accordion.mdx'

# Navigate the Dashboard
# Navigation

Welcome to your SignalWire Dashboard!
<Subtitle>The SignalWire Dashboard</Subtitle><br/><br/>

<Frame
caption="The Home page of the Dashboard shows stats for recent usage across the current SignalWire Space."
Expand All @@ -22,55 +22,70 @@ Welcome to your SignalWire Dashboard!

<NewLegacy />

## Toolbar

In the upper-right corner, you'll notice your toolbar has several items of importance.

By clicking the bell, you can see our updates of new API features, updates to current APIs, upcoming LiveWire sessions to demonstrate SignalWire capabilities with real time Q&A, and more.
To the right of that, a help menu provides you with helpful links for further information and support.
Finally, the account icon with the drop-down menu on the far right will allow you to view your profile or log out.

<Frame caption="Top toolbar in your SignalWire Space.">
## Space menu

![Top toolbar in your SignalWire Space with a notification icon, a link to 'Help', and a profile icon.](@image/dashboard/toolbar-right.png)
The upper-left corner of the Dashboard features two important menus.
Access the first by clicking on the name (subdomain) of your SignalWire Space:

<Frame caption="Open the Space menu by clicking on the name of your space.">
![The SignalWire Space menu.](@image/dashboard/left-menu/menu.webp)
</Frame>

When you click on the dropdown menu to the view your profile, you will see additional options including **"Profile, Billing, Users, and Settings"** as well as the option to switch SignalWire Spaces or log out.

:::info Admin pages
### Space settings

<div className="row">

<div className="col col--6">
Here you can update your Space's display name, geographic permissions, and enable protection on media URLs.
</div>

<div className="col col--6">
<Card title="International calling and messaging" href="/platform/dashboard/guides/how-to-enable-international-outbound-dialing-sms/">
Learn more about international support, and how to request international activation
</Card>
</div>

</div>

### Members {#users}

The **Members** page shows all users (depending on if you are an admin or not) and lets you invite other users.
You can also invite users and restrict them to only being able to see specified projects.

You will not be able to view Billing, Users, or Settings unless you are an Admin on that SignalWire Space.
<Frame caption="Users screen. All the users on your Space are listed here.">

:::
![Users tab, showing a table of users and details about each user.](@image/dashboard/users.webP)

<Frame caption="Profile menu.">
</Frame>

![Profile menu with options to view Profile, Billing, Users, Settings, Switch Spaces, and Log out.](@image/dashboard/toolbar-profile-dropdown.png)
### Usage and billing

</Frame>
Find information about account status, payment methods, past statements, payment history, and
[auto-top-up](/platform/dashboard/guides/how-to-set-auto-top-up-by-credit-card/#auto-top-up)
in this section.

---

### Users

The **Users** tab shows all users (depending on if you are an admin or not) and lets you invite other users.
You can also invite users and restrict them to only being able to see specified projects.
## Toolbar

<Frame caption="Users screen. All the users on your Space are listed here.">
The upper-right area of the toolbar has these menus:

![Users tab, showing a table of users and details about each user.](@image/dashboard/users.webP)
- **Notifications:** Click the bell button to view the product and event feed.
- **Help:** Click the `?` button for support and help resources.
- **Account:** Click your profile picture to edit your profile, enable Multi-Factor Authentication, change your password, or generate a
[Personal Access Token](#personal-access-tokens).

<Frame caption="Top toolbar in your SignalWire Space.">
![Top toolbar in your SignalWire Space with a notification icon, a link to 'Help', and a profile icon.](@image/dashboard/toolbar-right.png)
</Frame>


---

## Side Navigational Bar
## Main sidebar {#side-navigational-bar}

On the lefthand side, you'll find the side nav bar.
At the top, you'll see your project name and two opposite facing arrows.
By clicking that button, you will see all of your projects and can easily switch between them.
On the lefthand side, you'll find the primary sidebar.
The top of the menu shows the name of the current Project.
Open this drop-down menu to view and switch between all Projects.


<Frame caption="At the top, clicking on the arrows lets you switch between Spaces. Below that you have the directory to each of the different pages within your portal.">
Expand Down Expand Up @@ -161,7 +176,7 @@ The **Logs** tab contains all of your logs for your project. Calling, Conferenci

---

### Personal Access Tokens
### Personal Access Tokens {#personal-access-tokens}

The **Personal Access Tokens** tab lets you create and manage your personal access tokens for supported applications (such as FreeSWITCH).

Expand Down
Binary file modified images/dashboard/left-menu/menu.webp
Binary file not shown.
Binary file removed images/dashboard/toolbar-profile-dropdown.png
Binary file not shown.
Binary file modified images/dashboard/toolbar-right.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion provisioning/nginx/redirects.map
Original file line number Diff line number Diff line change
Expand Up @@ -1223,4 +1223,6 @@
/page/your-signalwire-video-space /platform/dashboard/get-started/explore#video;
/page/your-signalwire-video-space/ /platform/dashboard/get-started/explore#video;
/help/your-signalwire-messaging-campaigns-space /platform/dashboard/get-started/explore#messaging-campaigns;
/help/your-signalwire-messaging-campaigns-space/ /platform/dashboard/get-started/explore#messaging-campaigns;
/help/your-signalwire-messaging-campaigns-space/ /platform/dashboard/get-started/explore#messaging-campaigns;
/sdks/reference/realtime-sdk/messaging /sdks/reference/realtime-sdk/relay-v4/messaging;
/sdks/reference/realtime-sdk/messaging/ /sdks/reference/realtime-sdk/relay-v4/messaging;