Skip to content

Commit

Permalink
[ENG-1881] Update docs (#2739)
Browse files Browse the repository at this point in the history
product documentation
  • Loading branch information
myung03 authored Oct 24, 2024
1 parent ea92383 commit 2a429cb
Show file tree
Hide file tree
Showing 8 changed files with 171 additions and 4 deletions.
20 changes: 20 additions & 0 deletions docs/product/guides/command-palette.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,23 @@ index: 100
---

# Command Palette

The Command Palette is a powerful tool designed to streamline navigation and provide quick access to key features in Spacedrive. It allows you to search, navigate, and execute commands without needing to leave your current workflow.

## How to Use the Command Palette

- **Open the Command Palette:**
Press `CMD + K` (on macOS) or `CTRL + K` (on Windows/Linux) to instantly bring up the command palette.

- **Search Functionality:**
You can search for specific files, folders, or any other items in your library. This includes documents, media, and metadata, allowing for fast and efficient access to your entire library.

- **Navigate Through Your Library:**
Easily move between different sections of your workspace by using the palette to jump to various parts of your project, such as folders, files, or even specific locations within those files.

- **Adding Locations or Creating Tags:**
The Command Palette allows you to quickly add new storage locations or create custom tags for better organization of your content. This feature enables easy tagging and sorting, making your files easier to find and categorize.

---

The Command Palette is designed to enhance your workflow by making it easier to access, organize, and navigate your files and content. Keep an eye out for future updates, as we continue to enhance the Command Palette with new features and improved functionality such as an AI assistant to make your workflow even more seamless.
46 changes: 46 additions & 0 deletions docs/product/guides/media-conversion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,49 @@ index: 100
title="WIP"
text="This feature is not available yet, please check our [roadmap](/roadmap)."
/>

Spacedrive makes it easy to manage your media files with powerful built-in conversion capabilities. Whether you need to change file formats, compress media for efficient storage, or ensure compatibility across different devices, Spacedrive's Media Conversion tools are here to help.

## Key Features of Media Conversion

- **Effortless Format Conversion:**
Spacedrive allows you to convert media files, including images, videos, and audio, to a variety of popular formats. This helps ensure your files are accessible and usable across different devices and platforms.

- **Supported File Types:**
You can convert between a wide range of file types, such as:

- Image formats: JPEG, PNG, SVG, WEBP, GIF, and more.
- Video formats: MP4, AVI, MOV, MKV, and others.
- Audio formats: MP3, WAV, AAC, FLAC, and more.

- **Batch Processing:**
Convert multiple media files at once with batch processing, saving you time when working with large libraries of media. Simply select the files you need to convert, choose your output format, and let Spacedrive handle the rest.

- **Compression for Optimal Storage:**
Media files can take up significant storage space, especially high-resolution images and videos. Spacedrive offers options for compressing files during conversion to reduce file size without sacrificing quality. This is particularly useful when managing decentralized storage.

- **Maintaining Metadata Integrity:**
During the conversion process, Spacedrive preserves important file metadata such as creation date, tags, and descriptions. This ensures that your organizational structure and file information remain intact even after conversion.

- **Seamless Integration with Decentralized Storage:**
Media conversion in Spacedrive is designed to work seamlessly within the decentralized file management environment. Whether your files are stored locally or across distributed storage nodes, you can easily convert and manage your media without limitations.

## How to Convert Media Files in Spacedrive

1. **Locate Your Media Files:**
Use the search or navigation features to find the media files you want to convert in your Spacedrive library.

2. **Open the Media Conversion Tool:**
Right-click on the file(s) and select "Convert" from the context menu, or use the Command Palette (`Command + K` / `Ctrl + K`) to search for the conversion command.

3. **Choose Your Target Format:**
Select the desired output format for your file. Options will vary depending on whether you're converting images, videos, or audio files.

4. **Optional Settings:**
Adjust additional options such as compression levels or resolution for video files. You can also choose whether to retain metadata or strip it for privacy.

5. **Start the Conversion:**
Click "Convert" to begin the process. You can monitor the conversion progress in the job manager, and batch conversions will queue for processing.

6. **Access Converted Files:**
Once the conversion is complete, the new file will be available in your library alongside the original, unless you choose to replace it.
20 changes: 20 additions & 0 deletions docs/product/guides/media-view.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,23 @@ index: 100
---

# Media View

The Media View feature in Spacedrive provides a streamlined way to browse and interact with your media files. It offers a visually engaging experience, allowing you to quickly view thumbnails, preview media, and navigate through your collection with ease.

## How to Open Media View

To open the Media View, simply navigate to any folder in Spacedrive that contains media files. This can include images, videos, or audio files.

## Key Features of Media View

- **Automatic Thumbnails:**
Spacedrive automatically generates thumbnails for all your media files, offering a quick and clear visual reference. Thumbnails make it easier to locate specific files, especially when browsing large folders.

- **Seamless Media Browsing:**
Easily view all your media files at a glance. The Media View displays your files in a grid, providing an organized overview of images, videos, and audio tracks. You can scroll through the folder to browse and quickly identify the media you're looking for.

- **Quick Previews:**
Press `Spacebar` on any media file will open the quick preview menu, allowing you to instantly view or play the file without leaving the current folder or opening a separate application.

- **Zoom and Layout Options:**
Press the filter button on the top right to customize how your media files are displayed, including item size, double click action, advanced explorer options, and sort rules.
4 changes: 2 additions & 2 deletions docs/product/guides/quick-preview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ index: 10

<Video url="/videos/Spacedrive_QuickPreview.webm" />

Quick Preview allows you to quickly preview a file in Spacedrive, it supports a wide and growing range of formats.
Quick Preview allows you to "quickly preview" a file in Spacedrive. It supports a wide and growing range of formats, providing an easy way to explore your files and data.

It can be accessed by pressing the spacebar while selected on a file, as per native behaviour for macOS.

Alternatively you can access it from the context menu.
Alternatively, you can access it from the context menu.
25 changes: 25 additions & 0 deletions docs/product/guides/search.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,28 @@ index: 100
---

# Search

The **Search** feature in Spacedrive makes it easy to find files across your entire library. Whether you're looking for a specific file by name or using advanced filters, Search is designed to help you locate your files quickly and efficiently.

## How to Use Search

- **Shortcut Key**: Press `CMD + F` (or `CTRL + F` on Windows/Linux) to access the search bar in Locations where search is available.
- **Access Through Explorer**: You also can use Search by typing in the top bar text area in the Explorer or Overview.

## Search by File Name

Search works primarily by matching file names. Just start typing in the search bar, and results will appear as you type.

## Apply Filters

To refine your search, click the **Add Filter** button. Available filters include:

- **Location**: Search within specific folders or drives.
- **Tags**: Narrow down results by tags you've applied to files.
- **Kind**: Filter by file type (e.g., document, image, video).
- **Name**: Search by exact or partial file name.
- **Extension**: Filter by file extension (e.g., `.jpg`, `.pdf`).
- **Hidden**: Show or hide hidden files in search results.
- **Favourite**: Only display files marked as favourites.

Using multiple filters together allows you to fine-tune your search and quickly locate even the most specific files.
12 changes: 12 additions & 0 deletions docs/product/guides/spacedrop.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,15 @@ index: 100
---

# Spacedrop

Spacedrop is a file-sharing feature designed for Spacedrive users. It allows you to instantly send files and folders to others within your network, directly from your Spacedrive interface. Spacedrop ensures fast, secure transfers without the need for cloud uploads or email attachments.

## Key Features

- **Instant Sharing**: Transfer files directly to nearby Spacedrive users connected on the same network quickly without having to waiting for uploads or email attachments
- **All File Types**: Share any selected file/folder on your library
- **Privacy**: Only the recipient can access the shared file, ensuring secure transfers.

## How to Use Spacedrop

Simply press the planet icon in the top right of the Explorer to access Spacedrop. Select a node and the file(s) you want to Spacedrop and share your files instantly between devices.
46 changes: 45 additions & 1 deletion docs/product/guides/spaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,48 @@ index: 100
text="This feature is not available yet, please check our [roadmap](/roadmap)."
/>

Spaces are virtual folders, they can contain files from various locations.
**Spaces** are virtual folders designed to foster collaboration and organization within Spacedrive. They allow you to share, curate, and customize a collection of files from various locations, making it easy to collaborate with others or manage your content just the way you want.

### What are Spaces?

Spaces are virtual folders designed to give you control over how you organize, share, and collaborate with others. Unlike traditional folders, a Space can contain files from various locations within your library. Whether it's documents, media files, or entire folders, you can curate your Space the way you want, without moving or duplicating your content.

### Build Your Space, Your Way

Creating a Space is simple, but what you can do with it is powerful:

- **Pin Key Folders**: Start by pinning important folders to the top of your Space for easy access. These could be work files, personal projects, or shared media collections—whatever matters most to you.
- **Curate Content**: Populate your Space with files from any part of your Spacedrive library. You can mix and match files, dragging them in from different storage locations, or organizing them however you prefer.

### Sharing and Collaboration Made Easy

A big focus of Spaces is **community** and **collaboration**. Whether you’re sharing your Space with teammates, friends, or collaborators, you can easily control access:

- **Invite Collaborators**: With just a few clicks, you can share your Space with others, giving them the ability to view, edit, or add their own content.
- **Set Permissions**: Need to control who can edit what? You have full control over permissions, allowing you to manage who can make changes and who can simply view the files.

### A Space for Every Purpose

Spaces are incredibly versatile. Here are just a few ways you can use them:

- **Team Projects**: Create a collaborative Space for team members to contribute files, share ideas, and work together. Pin important folders or files for quick reference.
- **Personal Organization**: Use Spaces to organize your personal files into meaningful categories, like photography projects, design inspiration, or family photos.
- **Community Resource Sharing**: Spaces make it easy to create a shared resource hub where others can access important documents, media, or references.

### Stay Organized with Flexibility

Because Spaces pull from various parts of your library, you don’t need to move files around to keep things organized. Simply pin what you need, and your files will be available within the Space, ready for you and your collaborators to access.

Want to add more structure? Use drag-and-drop functionality to arrange files or folders within the Space. You’re in full control of how everything is displayed, giving you the freedom to build a Space that matches your workflow.

### Privacy and Security

Sharing doesn’t mean compromising on security. With Spaces, you can decide who has access to your content. You can:

- Make a Space private, accessible only to you.
- Share it with specific individuals or groups.
- Set read-only or full-edit permissions, ensuring that your files are protected while still enabling collaboration.

---

**Spaces** are built to grow and evolve with you. Whether you're organizing personal files, collaborating with a team, or building a community around shared resources, Spaces give you the tools to do it your way. Jump in, create your first Space, and start collaborating today!
2 changes: 1 addition & 1 deletion docs/product/guides/tags.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Tags can be added from the context menu - right click a file and select "Assign

Alternatively, the [Inspector]() which can be accessed from both the Explorer and Quick Preview has the ability to view and manage tags.

We are working on a "tag assign mode" which will show relevent tags on a hotbar at the bottom of the Explorer. Each tag will be assigned a number, selecting files and pressing the number will assign the given tag to all selected files.
To enter tag assign mode, press the Tag icon in the Explorer and assign number keys to each of your tags. Press the corresponding number key to assign tags to files in the Explorer with ease.

### Managing tags

Expand Down

0 comments on commit 2a429cb

Please sign in to comment.