From 2a429cbeaff9dc4bfb6258e3705653a63300a5d5 Mon Sep 17 00:00:00 2001 From: Matthew Yung <117509016+myung03@users.noreply.github.com> Date: Thu, 24 Oct 2024 00:59:54 -0700 Subject: [PATCH] [ENG-1881] Update docs (#2739) product documentation --- docs/product/guides/command-palette.mdx | 20 +++++++++++ docs/product/guides/media-conversion.mdx | 46 ++++++++++++++++++++++++ docs/product/guides/media-view.mdx | 20 +++++++++++ docs/product/guides/quick-preview.mdx | 4 +-- docs/product/guides/search.mdx | 25 +++++++++++++ docs/product/guides/spacedrop.mdx | 12 +++++++ docs/product/guides/spaces.mdx | 46 +++++++++++++++++++++++- docs/product/guides/tags.mdx | 2 +- 8 files changed, 171 insertions(+), 4 deletions(-) diff --git a/docs/product/guides/command-palette.mdx b/docs/product/guides/command-palette.mdx index 4fbdcf6218a2..c85507811d37 100644 --- a/docs/product/guides/command-palette.mdx +++ b/docs/product/guides/command-palette.mdx @@ -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. diff --git a/docs/product/guides/media-conversion.mdx b/docs/product/guides/media-conversion.mdx index 60ed908418c3..031f3b66f171 100644 --- a/docs/product/guides/media-conversion.mdx +++ b/docs/product/guides/media-conversion.mdx @@ -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. diff --git a/docs/product/guides/media-view.mdx b/docs/product/guides/media-view.mdx index fa1befe0d1cd..2330a6577be2 100644 --- a/docs/product/guides/media-view.mdx +++ b/docs/product/guides/media-view.mdx @@ -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. diff --git a/docs/product/guides/quick-preview.mdx b/docs/product/guides/quick-preview.mdx index c7df1741ca06..be642aa78b9b 100644 --- a/docs/product/guides/quick-preview.mdx +++ b/docs/product/guides/quick-preview.mdx @@ -6,8 +6,8 @@ index: 10