Skip to content

Commit

Permalink
amendments and updates
Browse files Browse the repository at this point in the history
  • Loading branch information
joeljkrb committed Sep 19, 2024
1 parent 27a6dfe commit 2e4fe38
Show file tree
Hide file tree
Showing 12 changed files with 91 additions and 11 deletions.
24 changes: 24 additions & 0 deletions docs/pages/console/basics/settings/tabs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Tabs

The Tabs settings in the Polkadot Developer Console allow you to customize the behavior and appearance of tabs. To access these settings:

1. Click on the Settings icon in the top-right corner of the console.
2. Select the "Tabs" tab in the Settings menu.

![Interface Overview](/png/tabs/hero.png)

## Tab Settings Options

### Chain Color Theming

When this setting is active, tabs are color-coded based on the associated chain's theme. This visual distinction makes it easier to identify and differentiate between tabs connected to various chains, enhancing navigation and organization within your workspace.

### Default Auto Connect

With this setting enabled, new tabs automatically attempt to connect to the selected chain or task upon creation. This streamlines your workflow by eliminating the need to manually initiate connections each time you open a new tab, allowing you to quickly access and work with different chains or tasks.

### Auto Tab Naming

When activated, this setting automatically renames tabs based on the chain or task they're connected to. This feature ensures that each tab is clearly labeled with relevant information, making it easier to identify the purpose or content of each tab at a glance, especially when working with multiple chains or tasks simultaneously.

These settings allow you to tailor your Polkadot Developer Console experience to best suit your workflow and preferences when managing multiple chains or tasks.
56 changes: 56 additions & 0 deletions docs/pages/console/basics/settings/tags.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Tags

Tags provide a flexible way to organize and filter chains within the Polkadot Developer Console. Users can utilize default tags or create custom tags to suit their specific needs. To access these settings:

1. Click on the Settings cog icon in the top-right corner of the console interface.
2. Select the "Tags" tab in the Settings menu.

![Interface Overview](/png/tags/hero.png)

## Managing Tags

### Viewing Existing Tags

The Tags management screen displays a list of all existing tags, both default and custom. For each tag, you can see:

- Tag name
- Number of chains the tag is applied to

![List of existing tags](/png/tags/tag-list.png)

### Creating a New Tag

To create a new tag:

1. Click the __+ New Tag__ button at the top-right of the Tags management screen.
2. Enter the desired name for your new tag in the "Tag Name" field.
3. Click __Create Tag__ to add the new tag to your list.

![New Tag creation](/png/tags/new-tag.png)

### Applying Tags to Chains

To apply a tag to a chain:

1. Navigate to the "Connect Chain" screen.
2. Locate the chain you want to tag in the chain list.
3. Click the __Add__ button next to the chain's existing tags.
4. Select the tag you want to apply from the dropdown menu.

![Applying tags to a chain](/png/tags/apply-tag.png)

### Filtering Chains by Tags

To filter chains using tags:

1. On the "Connect Chain" screen, locate the "Tags" section above the chain list.
2. Click on one or more tags to filter the chain list. The list will show chains that have any of the selected tag(s).
3. To clear filters, click the __Clear__ button next to the Tags section.

## Use Cases for Tags

- Group chains by network (e.g., Polkadot, Kusama, Westend)
- Categorize chains by type (e.g., Relay Chain, System Chain, Parachain)
- Create custom categories for specific projects or use cases

By utilizing tags effectively, developers can create a highly organized workspace within the Polkadot Developer Console, tailored to their specific project needs and workflow preferences.
6 changes: 0 additions & 6 deletions docs/pages/console/basics/settings/workspaces.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
id: workspaces
title: Workspaces
sidebar_position: 6
---

# Workspaces

Workspaces provide developers with essential functionalities for managing their workspace state by providing import and export capabilities, as well as the ability to reset the workspace to its default state.
Expand Down
3 changes: 1 addition & 2 deletions docs/pages/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,4 @@ We also host a [blog](/blog) where we share the latest updates to Polkadot Cloud

## Next Steps

Visit the [next page](/console/overview) for an overview of the Polkadot Developer Console.

Visit the [next page](/console/overview) for an overview of the Polkadot Developer Console.
Binary file added docs/public/png/tabs/hero.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/png/tags/apply-tag.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/png/tags/hero.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/png/tags/new-tag.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/png/tags/tag-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@
"react": "latest",
"react-dom": "latest",
"typescript": "latest",
"vocs": "1.0.0-alpha.55"
"vocs": "^1.0.0-alpha.55"
}
}
9 changes: 8 additions & 1 deletion vocs.config.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,18 @@ export default defineConfig({
text: 'Interface Overview',
link: '/console/basics/interface-overview',
},

{
text: 'Settings',
collapsed: false,
items: [
{
text: 'Tabs',
link: '/console/basics/settings/tabs',
},
{
text: 'Tags',
link: '/console/basics/settings/tags',
},
{
text: 'Workspaces',
link: '/console/basics/settings/workspaces',
Expand Down

0 comments on commit 2e4fe38

Please sign in to comment.