Roadmap updates (#2209)

* roadmap updates * moved target * Update setup.mdx * Update setup.mdx Add Notice about possible Docker Warning that Spacedrive Server runs the best on Linux/amd64. Also added a warning that mobile is not ready for public beta testing yet. * fix setup * docs: add note about appimage log viewing * docs: add URL to github issues regarding bug reporting --------- Co-authored-by: Utku <[email protected]> Co-authored-by: Arnab Chakraborty <[email protected]> Co-authored-by: jake <[email protected]>
spacedriveapp · Mar 16, 2024 · a13a054 · a13a054
1 parent 52d7c57
commit a13a054
Show file tree

Hide file tree

Showing 5 changed files with 159 additions and 47 deletions.
diff --git a/.cspell/project_words.txt b/.cspell/project_words.txt
@@ -57,6 +57,7 @@ spacetunnel
 specta
 storedkey
 stringly
+thumbstrips
 tobiaslutke
 typecheck
 vdfs

diff --git a/apps/landing/src/app/roadmap/items.ts b/apps/landing/src/app/roadmap/items.ts
@@ -49,13 +49,13 @@ export const items = [
 	},
 	{
 		completed: true,
-		title: 'Quick View',
+		title: 'Quick view',
 		description:
 			'View images, videos and documents in a full screen modal with nested inspector and context switcher.'
 	},
 	{
 		completed: true,
-		title: 'Media View',
+		title: 'Media view',
 		description: 'Turn any directory into a camera roll including media from subdirectories'
 	},
 	{
@@ -74,48 +74,64 @@ export const items = [
 		completed: true,
 		description: 'Drag and drop files between devices and drives.'
 	},
+	{
+		title: 'Language support',
+		completed: true,
+		description: 'Support for 12+ languages, with a community-driven translation via i18n.'
+	},
 	{
 		when: '0.2 Alpha',
-		subtext: 'January 2024',
-		title: 'Column View',
-		description: 'View files in the beloved column layout with a nested inspector, with trees!.'
+		subtext: 'February 2024',
+		title: 'Column view',
+		description: 'View files in the beloved column layout with a nested inspector, with trees!'
 	},
 	{
-		title: 'Command Palette',
+		title: 'Improved file transfers',
+		description:
+			'Instant copy for files on the same device. An improved progress bar and speed indicator. Pause, resume and prioritize transfers.'
+	},
+	{
+		title: 'Folder sync',
 		description:
-			'Quickly navigate to any file or folder from anywhere in the app, along with AI search!'
+			'Configure replication or bidirectional sync between folders on any device or drive.'
 	},
 	{
 		title: 'File converter',
 		description: 'Convert image and video between common formats from the context menu.'
 	},
 	{
-		title: 'Folder sync',
-		description:
-			'Configure replication or bidirectional sync between folders on any device or drive.'
+		title: 'Command Palette',
+		description: 'Quickly navigate to any file or folder from anywhere in the app.'
 	},
 	{
-		title: 'Advanced media analysis',
-		description: 'Transcribe audio, identify faces, video scenes and more.'
+		title: 'Video thumbstrips',
+		description:
+			'Generate and display thumbstrips for videos, with a scrubber to preview the video.'
 	},
 	{
 		when: '0.3 Alpha',
-		subtext: 'Q2 2024',
-		title: 'Connect devices & sync',
+		subtext: 'April 2024',
+		title: 'Connect devices & Library sync',
 		description: 'Automatically synchronized libraries across all your devices.'
 	},
 	{
-		title: 'Mobile app testflight',
-		description: 'Access your library on the go, with a mobile app for iOS and Android.'
+		title: 'Key manager',
+		description:
+			'View, mount, unmount and hide keys. Mounted keys can be used to instantly encrypt and decrypt any files on your node.'
 	},
 	{
-		title: 'Spacedrive in every language, i18n',
-		description: 'Spacedrive will be available in every language.'
+		title: 'Mobile app TestFlight',
+		description:
+			'Access your library on the go, with a mobile app for iOS and Android in alpha via TestFlight and Play Store.'
 	},
 	{
-		title: 'Key manager',
+		title: 'Advanced media analysis',
+		description: 'Transcribe audio, identify faces, video scenes and more.'
+	},
+	{
+		title: 'Third-party cloud integrations',
 		description:
-			'View, mount, unmount and hide keys. Mounted keys can be used to instantly encrypt and decrypt any files on your node.'
+			'Filesystem integrations with iCloud, Google Drive, Dropbox, OneDrive & Mega + easy API for the community to add more.'
 	},
 	{
 		title: 'Comments',
@@ -124,56 +140,53 @@ export const items = [
 	},
 	{
 		when: '0.4 Alpha',
-		subtext: 'Q2 2024',
-		title: 'Third-party cloud integrations',
+		subtext: 'May 2024',
+		title: 'AI search',
 		description:
-			'Filesystem integrations with iCloud, Google Drive, Dropbox, OneDrive & Mega + easy API for the community to add more.'
+			'Search the contents of your files, including images, audio and video with a deep understanding of context and content.'
+	},
+
+	{
+		title: 'Spaces',
+		description:
+			'Create and manage Spaces, hosted locally or on the cloud, to share with friends or publish on the web. Spaces are AI native, with a custom local language model that can converse with the user and puppeteer the Explorer view.'
 	},
 	{
 		title: 'Spacedrive Cloud',
 		description:
 			'Backup and sync from anywhere with a Spacedrive Cloud account. Paid plans for additional storage and cloud features.'
 	},
 	{
-		title: 'Hosted Spaces',
-		description: 'Host select Spaces on our cloud to share with friends or publish on the web.'
+		title: 'Web portal',
+		description:
+			'Access the web interface via the browser, remotely access your library and manage your devices and Spaces.'
 	},
 	{
-		title: 'iOS & Android Release',
+		title: 'iOS & Android release',
 		description: 'Spacedrive will be available on the App Store and Google Play Store.'
 	},
 	{
-		when: '0.5 Beta',
-		subtext: 'Q3 2024',
-		title: 'Extensions',
+		title: 'File versioning',
 		description:
-			'Build tools on top of Spacedrive, extend functionality and integrate third party services. Extension directory on spacedrive.com/extensions.'
+			'Automatically save versions of files when they change, with a timeline view and the ability to restore.'
 	},
 	{
+		when: '0.5 Beta',
+		subtext: 'June 2024',
 		title: 'Encrypted vault(s)',
 		description:
 			'Effortlessly manage & encrypt sensitive files. Encrypt individual files or create flexible-size vaults.'
 	},
 	{
-		title: 'Security Audit',
-		description:
-			'We will hire a third party security firm to audit the codebase and ensure the highest level of security.'
-	},
-	{
-		when: 'Release',
-		subtext: 'Q4 2024',
-		title: 'Timeline',
-		description:
-			'View a linear timeline of content, travel to any time and see media represented visually.'
-	},
-	{
-		title: 'Redundancy',
+		title: 'Extensions',
 		description:
-			'Ensure a specific amount of copies exist for your important data, discover at-risk files and monitor device/drive health.'
+			'Build tools on top of Spacedrive, extend functionality and integrate third party services. Extension directory on spacedrive.com/extensions.'
 	},
 	{
-		title: 'Workers',
+		when: '1.0 Release',
+		subtext: '2025',
+		title: 'Security audit',
 		description:
-			'Utilize the compute power of your devices in unison to encode and perform tasks at increased speeds.'
+			'We will hire a third party security firm to audit the codebase and ensure the highest level of security.'
 	}
 ];
diff --git a/apps/landing/src/app/roadmap/page.tsx b/apps/landing/src/app/roadmap/page.tsx
@@ -20,6 +20,9 @@ export default function Page() {
 					Here is a list of the features we are working on, and the progress we have made
 					so far.
 				</p>
+				<p>
+					Last updated: <span className="font-bold text-white">March 13, 2024</span>
+				</p>
 			</section>
 			<section className="grid auto-cols-auto grid-flow-row grid-cols-[auto_1fr] gap-x-4">
 				{items.map((item, i) => (

diff --git a/docs/product/getting-started/setup.mdx b/docs/product/getting-started/setup.mdx
@@ -5,7 +5,98 @@ index: 0
 
 # Setup
 
+You can install Spacedrive on your computer, mobile device or server by following the instructions below.
+
+## Install
+
+### Desktop Installer
+
+You can download the Spacedrive desktop app from the links below.
+
+- <a href="https://www.spacedrive.com/api/releases/desktop/stable/darwin/aarch64">Apple Silicon</a>
+- <a href="https://www.spacedrive.com/api/releases/desktop/stable/darwin/x86_64">macOS Intel</a>
+- <a href="https://www.spacedrive.com/api/releases/desktop/stable/windows/x86_64">Windows</a>
+- <a href="https://www.spacedrive.com/api/releases/desktop/stable/linux/x86_64">Linux</a>
+
+### Homebrew
+
+Homebrew is a package manager for macOS and Linux. You can install Spacedrive using the following command.
+
+```bash
+brew install --cask spacedrive
+```
+
+### Docker
+
+You can run Spacedrive in a Docker container using the following command.
+
 <Notice
 	type="note"
-	text="Spacedrive is not yet released, these docs are a work in progress. Check out our [roadmap](/roadmap) to see a timeline leading to release!"
+	text="For the best performance of the docker container, we recommend to run on Linux (linux/amd64). The container is not yet optimized for other platforms."
+/>
+
+```bash
+docker run -d --name spacedrive -p 8080:8080 -v /var/spacedrive:/var/spacedrive ghcr.io/spacedriveapp/spacedrive/server
+```
+
+### Mobile (Preview)
+
+Take your Spacedrive library on the go with our mobile apps. You can join the betas by following the links below.
+
+<Notice
+	type="warning"
+	text="Spacedrive is not yet released on mobile platforms. Check out our [roadmap](/roadmap) to see a timeline leading to release!"
 />
+
+## App data
+
+When opening Spacedrive for the first time, a data folder is created in the following location:
+
+- macOS: `~/Library/Application Support/spacedrive`
+- Windows: `%APPDATA%\spacedrive` or `C:\Users\{username}\AppData\Roaming\spacedrive`
+- Linux: `~/.local/share/spacedrive`
+
+This folder contains the SQLite databases for each Library, configuration files, perma-cached thumbnail data and logs.
+
+## Having issues?
+
+We're still in alpha, so there are a few known issues. If you're having trouble, please check the following. You can join our [Discord](https://discord.gg/gTaF2Z44f5) server to ask for help or [report a bug on GitHub](https://github.com/spacedriveapp/spacedrive/issues).
+
+### Spacedrive is not opening
+
+We are working on fixing this issue happening at all, but for now if Spacedrive won't open, you can try the following:
+
+- Move and BACKUP your app data folder (explained above) to another location and try opening Spacedrive again. This likely means your app data is corrupted or outdated, if you have used a much earlier version of Spacedrive.
+- Run this command to clear the local storage of the webapp:
+  macOS:
+  ```bash
+  rm -rf "$HOME/Library/WebKit/Spacedrive" "$HOME/Library/Caches/Spacedrive" "$HOME/Library/WebKit/com.spacedrive.desktop" "$HOME/Library/Caches/com.spacedrive.desktop"
+  ```
+  Windows:
+  ```bash
+  rm -rf  "~/.local/share/com.spacedrive.desktop/" "~/.cache/spacedrive"
+  ```
+
+### Debugging
+
+Opening Spacedrive via the command line will reveal live debug logging in your terminal.
+
+**macOS**
+
+```bash
+~/Applications/Spacedrive.app/Contents/MacOS/Spacedrive
+```
+
+**Windows**
+
+```bash
+C:\Program Files\Spacedrive\Spacedrive.exe
+```
+
+**Linux**
+
+```bash
+/opt/Spacedrive/Spacedrive
+```
+
+- Alternatively you may launch the AppImage from a terminal to view the logs.
diff --git a/docs/product/guides/interface.mdx b/docs/product/guides/interface.mdx
@@ -8,6 +8,8 @@ Let's start by getting a clear understanding of the Spacedrive interface. Design
 
 ## Launch with CTRL+SPACE
 
+<Notice type="info" text="This feature is coming in mid April 2024" />
+
 A single keybind to launch Spacedrive from anywhere, you can define from the settings how Spacedrive should present itself on this keybind.
 
 ## Sidebar
@@ -26,6 +28,8 @@ The sidebar starts with a library switcher, this allows you to change the entire
 
 ## Command Pallette
 
+<Notice type="info" text="This feature is coming in mid April 2024" />
+
 ## Search
 
 {/* ![image](/thumbnails.webp) */}