diff --git a/README.md b/README.md index 3f2a43d1..da16581d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ logo -**Slash** is an open source, self-hosted bookmarks and link sharing platform. It allows you to organize your links with tags, and share them using custom shortened URLs. Slash also supports team sharing of link libraries for easy collaboration. +**Slash** is an open source, self-hosted bookmarks and link sharing platform. It allows you to organize your links with tags, and share them with custom shortened URLs. Slash also supports team sharing of link libraries for easy collaboration. 🧩 Browser extension(v1.0.0) now available! - [Chrome Web Store](https://chrome.google.com/webstore/detail/slash/ebaiehmkammnacjadffpicipfckgeobg), [Firefox Add-on](https://addons.mozilla.org/firefox/addon/your-slash/) @@ -15,6 +15,12 @@ ![demo](./resources/demo.png) +## Background + +In today's workplace, essential information is often scattered across the cloud in the form of links. We understand the frustration of endlessly searching through emails, messages, and websites just to find the right link. Links are notorious for being unwieldy, complex, and easily lost in the shuffle. Remembering and sharing them can be a challenge. + +That's why we developed Slash, a solution that transforms these links into easily accessible, discoverable, and shareable shortcuts(e.g., `s/shortcut`). Say goodbye to link chaos and welcome the organizational ease of Slash into your daily online workflow. + ## Features - Create customizable `/s/` short links for any URL. diff --git a/docs/getting-started/collections.md b/docs/getting-started/collections.md index 9385853c..4c340653 100644 --- a/docs/getting-started/collections.md +++ b/docs/getting-started/collections.md @@ -1 +1,43 @@ -# Collections +# Slash Collections + +**Slash Collections** introduces a feature to help you better organize and manage related Shortcuts within the Slash Shortcuts platform. + +## What is a Collection? + +A Collection is like a virtual folder where you can group and organize your related Shortcuts. It acts as a container that holds Shortcuts together for a specific purpose or theme. Let's break down the key attributes: + +- **Name:** Your chosen label for the Collection. This becomes a crucial part of the URL, enabling direct and quick access to the Collection. For example, if your Collection is named "work-projects", the direct access link would be `c/work-projects`. This user-defined name significantly enhances the accessibility and recognition of your Collections. +- **Title:** A brief title summarizing the Collection's content. +- **Description:** A short description explaining what the Collection is about. +- **Shortcuts:** The Shortcuts included in the Collection. +- **Visibility:** Settings to control who can access the Collection. + +## What Problems Does It Solve? + +Slash Collections tackle the challenge of efficiently managing and organizing related Shortcuts. By grouping Shortcuts into Collections, you can create a more structured and accessible workflow. This makes it easier to find, access, and share information based on specific themes or projects. + +## How to Use Collections + +### Creating a Collection + +1. **Define the Collection:** Give your Collection a meaningful name and a descriptive title. +2. **Add Details:** Provide a brief description of the content within the Collection. +3. **Add Shortcuts:** Include relevant Shortcuts by selecting them from your existing list. +4. **Set Visibility:** Choose who should have access to the Collection. +5. **Save:** Once saved, your Collection is ready to use. + +### Accessing Collections + +Access a Collection directly by using the assigned name. For example, if your Collection is named "work-projects", the direct access link would be `{YOUR_DOMAIN}/c/work-projects`. + +### Updating and Managing Collections + +Modify Collection details, such as name, title, or included Shortcuts, to keep your organization streamlined and relevant. + +### Sharing Collections + +Share Collections by providing the assigned name to collaborators for easy access to grouped Shortcuts. + +## Conclusion + +Slash Collections offer a user-friendly and organized way to group, manage, and share related Shortcuts. By utilizing the defined Collection attributes, users can seamlessly categorize and access information, promoting collaboration and improving overall productivity. diff --git a/docs/getting-started/shortcuts.md b/docs/getting-started/shortcuts.md index f1d5fdd9..5b4d4d02 100644 --- a/docs/getting-started/shortcuts.md +++ b/docs/getting-started/shortcuts.md @@ -1 +1,47 @@ -# Shortcuts +# Slash Shortcuts + +**Slash Shortcuts** is a handy tool designed to make handling and sharing links in your digital workspace a breeze. + +## What is a Shortcut? + +A Shortcut is a simplified version of a link with essential details, making it easy to remember, organize, and share. Let's break down the key elements: + +- **Name:** Your chosen label for the Shortcut. This becomes a crucial part of the URL, enabling direct and quick access to the Shortcut. For example, if your Shortcut is named "meet-john", the direct access link would be `s/meet-john`. This user-defined name significantly enhances the accessibility and recognition of your Shortcuts. +- **Link:** The original web link you want to streamline. +- **Title:** A quick overview of what's behind the link. +- **Tags:** Custom labels for easy sorting. +- **Description:** A short summary of the content. +- **Visibility:** Controls who can access the Shortcut. + +## How to Use Shortcuts + +### Creating a Shortcut + +1. **Define the Link:** Paste the original link you want to simplify. +2. **Add Details:** Give it a name, tags, and a brief description for better organization. +3. **Set Visibility:** Choose who should be able to access the Shortcut. +4. **Save:** Once saved, your Shortcut is ready to go. + +### Accessing Shortcuts + +#### Direct Access + +Effortlessly access your Shortcut's content directly by using the assigned name as part of the Slash Shortcuts format. + +For example, if your Shortcut is named "meet-john", the direct access link would be `{YOUR_DOMAIN}/s/meet-john`. Simply enter this user-friendly shortcut into your browser to reach the associated content with ease. + +#### Browser Extension Access + +Install the Slash Shortcuts browser extension for even quicker access. Once installed, simply type `s/meet-john` into your browser's address bar, and the extension will seamlessly redirect you to the corresponding page. + +### Updating and Managing Shortcuts + +Adjust attributes like name and tags to update a Shortcut. Keep your Shortcuts organized based on categories and visibility settings. + +### Sharing Shortcuts + +Share Shortcuts by providing the assigned name to collaborators for easy access. + +## Conclusion + +Shortcuts provide a simple way to manage, organize, and share links within your digital workspace. By using the defined Shortcut attributes, users can easily create, access, and share information, promoting collaboration and boosting productivity. diff --git a/frontend/web/src/components/CreateCollectionDialog.tsx b/frontend/web/src/components/CreateCollectionDialog.tsx index 932ac3b6..10b96452 100644 --- a/frontend/web/src/components/CreateCollectionDialog.tsx +++ b/frontend/web/src/components/CreateCollectionDialog.tsx @@ -136,7 +136,7 @@ const CreateCollectionDialog: React.FC = (props: Props) => { } } catch (error: any) { console.error(error); - toast.error(error.response.data.message); + toast.error(error.details); } };