More important docs! (#2317)

* docs * docs * doc * revert * revert * move actions to arch * docs * docssss * typo * duplicate * fix date * x * jobs * jobs * Update jobs.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update jobs.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update libraries.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update spaces.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update spaces.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update spaces.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update introduction.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update clouds.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update clouds.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update clouds.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update importing-photos.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update interface.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update jobs.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update library-setup.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update locations.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update quick-preview.mdx Co-authored-by: 0xBA5E64 <[email protected]> * Update quick-preview.mdx Co-authored-by: 0xBA5E64 <[email protected]> * changes * stuff * fix * rag stuff wip * Update docs/product/guides/importing-photos.mdx Co-authored-by: 0xBA5E64 <[email protected]> * del * fixed typos/changed wording for some docs --------- Co-authored-by: Utku <[email protected]> Co-authored-by: 0xBA5E64 <[email protected]> Co-authored-by: myung03 <[email protected]>
spacedriveapp · May 15, 2024 · 0ccc038 · 0ccc038
1 parent ad80aa2
commit 0ccc038
Show file tree

Hide file tree

Showing 47 changed files with 517 additions and 195 deletions.
diff --git a/apps/landing/public/images/agent.webp b/apps/landing/public/images/agent.webp
diff --git a/apps/landing/public/images/tags.webp b/apps/landing/public/images/tags.webp
diff --git a/apps/landing/public/library_switcher.webp b/apps/landing/public/library_switcher.webp
diff --git a/apps/landing/public/videos/Spacedrive_QuickPreview.webm b/apps/landing/public/videos/Spacedrive_QuickPreview.webm
diff --git a/apps/landing/src/app/roadmap/items.ts b/apps/landing/src/app/roadmap/items.ts
@@ -110,19 +110,22 @@ export const items = [
 	},
 	{
 		when: '0.3 Alpha',
-		subtext: 'April 2024',
-		title: 'Connect devices & Library sync',
+		subtext: 'May 2024',
+		title: 'Connect devices & sync',
 		description: 'Automatically synchronized libraries across all your devices.'
 	},
 	{
-		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: 'Mobile app TestFlight & Play Store Beta',
+		description: 'Access your library on the go, with a mobile app for iOS and Android.'
 	},
 	{
-		title: 'Mobile app TestFlight',
+		title: 'Spacedrive in every language, i18n',
+		description: 'Spacedrive will be available in every language.'
+	},
+	{
+		title: 'Key manager',
 		description:
-			'Access your library on the go, with a mobile app for iOS and Android in alpha via TestFlight and Play Store.'
+			'View, mount, unmount and hide keys. Mounted keys can be used to instantly encrypt and decrypt any files on your node.'
 	},
 	{
 		title: 'Advanced media analysis',
@@ -140,7 +143,7 @@ export const items = [
 	},
 	{
 		when: '0.4 Alpha',
-		subtext: 'May 2024',
+		subtext: 'June 2024',
 		title: 'AI search',
 		description:
 			'Search the contents of your files, including images, audio and video with a deep understanding of context and content.'
@@ -156,6 +159,11 @@ export const items = [
 		description:
 			'Backup and sync from anywhere with a Spacedrive Cloud account. Paid plans for additional storage and cloud features.'
 	},
+	{
+		title: 'CLI',
+		description:
+			'Access Spacedrive from the command line, with a rich set of commands to manage your library and devices.'
+	},
 	{
 		title: 'Web portal',
 		description:
@@ -177,15 +185,15 @@ export const items = [
 	},
 	{
 		when: '0.5 Beta',
-		subtext: 'June 2024',
+		subtext: 'August 2024',
 		title: 'Encrypted vault(s)',
 		description:
 			'Effortlessly manage & encrypt sensitive files. Encrypt individual files or create flexible-size vaults.'
 	},
 	{
 		title: 'Extensions',
 		description:
-			'Build tools on top of Spacedrive, extend functionality and integrate third party services. Extension directory on spacedrive.com/extensions.'
+			'Build tools on top of Spacedrive, extend functionality and integrate third party services.'
 	},
 	{
 		when: '1.0 Release',

diff --git a/docs/company/branding/logo.mdx b/docs/company/branding/logo.mdx
diff --git a/docs/company/branding/typography.mdx b/docs/company/branding/typography.mdx
diff --git a/docs/company/legal/privacy.mdx b/docs/company/legal/privacy.mdx
@@ -1,3 +1,16 @@
 # Privacy Policy
 
-_This page has yet to be written out in full. Please check back later!_
+**Effective date:** January 1st, 2024
+
+Welcome to Spacedrive Technology Inc. ("Spacedrive", "we", "us", or "our"). Spacedrive is committed to protecting your privacy. This Privacy Policy outlines the types of information we may collect from you or that you may provide when you visit the website [https://spacedrive.com](https://spacedrive.com) ("Website") and our practices for collecting, using, maintaining, protecting, and disclosing that information.
+
+This policy applies to information we collect:
+
+- On this Website.
+- In email, text, and other electronic messages between you and this Website.
+- Through mobile, web, and desktop applications you download from this Website, which provide dedicated non-browser-based interaction between you and this Website.
+
+It does not apply to information collected by:
+
+- us offline or through any other means, including on any other website operated by Spacedrive or any third party; or
+- any third party, including through any application or content (including advertising) that may link to or be accessible from the Website.
diff --git a/docs/company/legal/terms.mdx b/docs/company/legal/terms.mdx
@@ -1,46 +1,52 @@
 # Terms of Service
 
-These terms and conditions outline the rules and regulations for the use of Spacedrive Technology Inc.'s Website, located at https://spacedrive.com.
+These terms and conditions outline the rules and regulations for the use of Spacedrive Technology Inc.'s Website, located at [https://spacedrive.com](https://spacedrive.com).
 
 By accessing this website, we assume you accept these terms and conditions. Do not continue to use Spacedrive if you do not agree to take all of the terms and conditions stated on this page.
 
-Cookies:
+## Cookies
+
 The website uses cookies to help personalize your online experience. By accessing Spacedrive, you agreed to use the required cookies.
 
 A cookie is a text file that is placed on your hard disk by a web page server. Cookies cannot be used to run programs or deliver viruses to your computer. Cookies are uniquely assigned to you and can only be read by a web server in the domain that issued the cookie to you.
 
 We may use cookies to collect, store, and track information for statistical or marketing purposes to operate our website. You have the ability to accept or decline optional Cookies. There are some required Cookies that are necessary for the operation of our website. These cookies do not require your consent as they always work. Please keep in mind that by accepting required Cookies, you also accept third-party Cookies, which might be used via third-party provided services if you use such services on our website, for example, a video display window provided by third parties and integrated into our website.
 
-License:
+## License
+
 Unless otherwise stated, Spacedrive Technology Inc. and/or its licensors own the intellectual property rights for all material on Spacedrive. All intellectual property rights are reserved. You may access this from Spacedrive for your own personal use subjected to restrictions set in these terms and conditions.
 
 You must not:
 
-Copy or republish material from Spacedrive
-Sell, rent, or sub-license material from Spacedrive
-Reproduce, duplicate or copy material from Spacedrive
-Redistribute content from Spacedrive
+- Copy or republish material from Spacedrive
+- Sell, rent, or sub-license material from Spacedrive
+- Reproduce, duplicate or copy material from Spacedrive
+- Redistribute content from Spacedrive
+
 This Agreement shall begin on the date hereof.
 
-Hyperlinking to our Content:
+## Hyperlinking to our Content
+
 The following organizations may link to our Website without prior written approval:
 
-Government agencies;
-Search engines;
-News organizations;
-Online directory distributors may link to our Website in the same manner as they hyperlink to the Websites of other listed businesses; and
-System-wide Accredited Businesses except soliciting non-profit organizations, charity shopping malls, and charity fundraising groups which may not hyperlink to our Web site.
+- Government agencies;
+- Search engines;
+- News organizations;
+- Online directory distributors may link to our Website in the same manner as they hyperlink to the Websites of other listed businesses; and
+- System-wide Accredited Businesses except soliciting non-profit organizations, charity shopping malls, and charity fundraising groups which may not hyperlink to our Web site.
+
 These organizations may link to our home page, to publications, or to other Website information so long as the link: (a) is not in any way deceptive; (b) does not falsely imply sponsorship, endorsement, or approval of the linking party and its products and/or services; and (c) fits within the context of the linking party's site.
 
 We may consider and approve other link requests from the following types of organizations:
 
-commonly-known consumer and/or business information sources;
-dot.com community sites;
-associations or other groups representing charities;
-online directory distributors;
-internet portals;
-accounting, law, and consulting firms; and
-educational institutions and trade associations.
+- Commonly-known consumer and/or business information sources;
+- Dot.com community sites;
+- Associations or other groups representing charities;
+- Online directory distributors;
+- Internet portals;
+- Accounting, law, and consulting firms; and
+- Educational institutions and trade associations.
+
 We will approve link requests from these organizations if we decide that: (a) the link would not make us look unfavorably to ourselves or to our accredited businesses; (b) the organization does not have any negative records with us; (c) the benefit to us from the visibility of the hyperlink compensates the absence of Spacedrive Technology Inc.; and (d) the link is in the context of general resource information.
 
 These organizations may link to our home page so long as the link: (a) is not in any way deceptive; (b) does not falsely imply sponsorship, endorsement, or approval of the linking party and its products or services; and (c) fits within the context of the linking party's site.
@@ -49,29 +55,35 @@ If you are one of the organizations listed in paragraph 2 above and are interest
 
 Approved organizations may hyperlink to our Website as follows:
 
-By use of our corporate name; or
-By use of the uniform resource locator being linked to; or
-Using any other description of our Website being linked to that makes sense within the context and format of content on the linking party's site.
+- By use of our corporate name; or
+- By use of the uniform resource locator being linked to; or
+- Using any other description of our Website being linked to that makes sense within the context and format of content on the linking party's site.
+
 No use of Spacedrive Technology Inc.'s logo or other artwork will be allowed for linking absent a trademark license agreement.
 
-Content Liability:
+## Content Liability
+
 We shall not be held responsible for any content that appears on your Website. You agree to protect and defend us against all claims that are raised on your Website. No link(s) should appear on any Website that may be interpreted as libelous, obscene, or criminal, or which infringes, otherwise violates, or advocates the infringement or other violation of, any third party rights.
 
-Reservation of Rights:
+## Reservation of Rights
+
 We reserve the right to request that you remove all links or any particular link to our Website. You approve to immediately remove all links to our Website upon request. We also reserve the right to amend these terms and conditions and its linking policy at any time. By continuously linking to our Website, you agree to be bound to and follow these linking terms and conditions.
 
-Removal of links from our website:
+## Removal of links from our website
+
 If you find any link on our Website that is offensive for any reason, you are free to contact and inform us at any moment. We will consider requests to remove links, but we are not obligated to or so or to respond to you directly.
 
 We do not ensure that the information on this website is correct. We do not warrant its completeness or accuracy, nor do we promise to ensure that the website remains available or that the material on the website is kept up to date.
 
-Disclaimer:
+## Disclaimer
+
 To the maximum extent permitted by applicable law, we exclude all representations, warranties, and conditions relating to our website and the use of this website. Nothing in this disclaimer will:
 
-limit or exclude our or your liability for death or personal injury;
-limit or exclude our or your liability for fraud or fraudulent misrepresentation;
-limit any of our or your liabilities in any way that is not permitted under applicable law; or
-exclude any of our or your liabilities that may not be excluded under applicable law.
+- Limit or exclude our or your liability for death or personal injury;
+- Limit or exclude our or your liability for fraud or fraudulent misrepresentation;
+- Limit any of our or your liabilities in any way that is not permitted under applicable law; or
+- Exclude any of our or your liabilities that may not be excluded under applicable law.
+
 The limitations and prohibitions of liability set in this Section and elsewhere in this disclaimer: (a) are subject to the preceding paragraph; and (b) govern all liabilities arising under the disclaimer, including liabilities arising in contract, in tort, and for breach of statutory duty.
 
 As long as the website and the information and services on the website are provided free of charge, we will not be liable for any loss or damage of any nature.
diff --git a/docs/product/guides/actions.mdx → docs/developers/architecture/actions.mdx b/docs/product/guides/actions.mdx → docs/developers/architecture/actions.mdx
diff --git a/docs/developers/architecture/albums.mdx b/docs/developers/architecture/albums.mdx
diff --git a/docs/developers/architecture/extensions.mdx b/docs/developers/architecture/extensions.mdx
diff --git a/docs/developers/architecture/jobs.mdx b/docs/developers/architecture/jobs.mdx
@@ -4,4 +4,14 @@ index: 10
 
 # Jobs
 
-jobs are computation tasks performed by nodes in a Spacedrive network, they can be created by any node and performed by any or all nodes.
+Spacedrive's job system is designed to handle any tasks that might take time to complete, such as indexing files and generating thumbnails.
+
+A small indicator is shown in the bottom left when a job is running; clicking it reveals the job manager.
+
+The job manager allows you to see current jobs, expand them to see various tasks part of that job. Jobs with only one task, such as copying a single file, will not be expandable by clicking.
+
+Jobs can be paused, resumed and canceled. Spacedrive will always try to restart jobs that were cut off by a restart or shutdown of Spacedrive.
+
+Job history can be cleared by hitting the small trash icon on the job manager. This will not remove any ongoing jobs.
+
+Up to 3 jobs can run simultaneously, although this may be configurable in the future. More CPU-intensive jobs like thumbnailing and labelling have an upper limit for CPU usage set in the General settings page.
diff --git a/docs/developers/architecture/libraries.mdx b/docs/developers/architecture/libraries.mdx
@@ -8,4 +8,23 @@ A library is the database that Spacedrive stores all file structures and metadat
 
 To learn how data is synchronized check out the documentation on [Sync](/docs/developers/architecture/sync).
 
+You must create a library to use Spacedrive. Users can also choose to create more librariesm, such as ones specifically for work. Spacedrive will run all your libraries in unison.
+
+Library data is never mixed or shared, even if two libraries are tracking the same Location.
+
+## Exporting a library
+
+## Encrypting a Library
+
 Libraries can be encrypted with a passphrase set by the user.
+
+<Notice
+	type="info"
+	text="This is how the feature is intended to work, but is currently being developed."
+/>
+
+You can encrypt a Library by clicking the Lock icon button in the Library Settings. Once you have set a master password, the Library will be encrypted. If a library is locked, you will be prompted to enter the password when you try to open it. You can set an expiration time for the password, after which you will be prompted to enter it again.
+
+When a library is encrypted, the data is encrypted on disk, but the files themselves are not encrypted. This means that if you have a library that is not encrypted, and you encrypt it, the files will not be re-encrypted, only the metadata will be encrypted.
+
+If you wish to learn about encrypting files, see [File Encryption](#).
diff --git a/docs/developers/architecture/search.mdx b/docs/developers/architecture/search.mdx
@@ -3,11 +3,3 @@ index: 11
 ---
 
 # Search
-
-Press CTRL+F while on a Spacedrive window to access search.
-
-By default you will search the active library, however by checking "Search all Libraries" you can perform a simultaneous search of all libraries loaded on a Node.
-
-Search results return Objects, Locations, Albums, Tags and Spaces
-
-Search can be filtered by `ObjectKind`, as well as dates.
diff --git a/docs/developers/architecture/spaces.mdx b/docs/developers/architecture/spaces.mdx
@@ -4,8 +4,20 @@ index: 5
 
 # Spaces
 
-Spaces are virtual folders that can be shared publicly on the internet, or privately with friends, family and teams. Spaces contain [Objects](/docs/developers/architecture/objects) which can be physically stored on any connected Node, or by Spacedrive as a service. Objects can be organized and presented spatially, with various layouts and variable grid placements. Color theme, icon packs and typography can be customized per Space.
+Spaces are virtual folders that can be shared publicly on the internet, or privately with friends, family and teams. Spaces contain [Objects](/docs/developers/architecture/objects) which can be hosted by any connected Node, or by Spacedrive as a service.
 
-Objects can be added to a Space manually, or by matching a defined ruleset, similar to Tags.
+Spaces can be shared with a unique URL, and can be embedded in websites, blogs and social media. Example: [sd.space/username/space](#).
 
-Spacedrive comes with pre-defined Spaces, such as: photos, videos, screenshots, documents.
+Objects can be added to a Space manually, or by matching a defined ruleset, similar to Tags. This mechanism is also used for the default Spaces such as favorites, photos, videos, documents and screenshots. Photos, being a Space, means that albums can be nested and contain various Object kinds.
+
+Spaces allow for permissions, which can be set to read-only, read-write, or read-write-delete for the entire Space, or per Object.
+
+When syncing a Space a folder is created somewhere on the user's system to sync the physical contents of the Space. This can be in the data folder of Spacedrive or at a path of the users choice. Metadata is ingested into the library
+
+Viewing a Space online or even opening it in the app will not add it to your Library. You must explicitly click "Add Space to Library" to sync it's contents, to which you can optionally configure the parameters.
+
+It is possible to put Tags and Locations and other strucured data models into a Space, in this case we will create an Object to represent it and handle syncing the Location, Tag or even another Space though a dedicated handler. For example when a foreign Location is loaded into a Space, we will sync the Location with their library, but it will be owned by the Space itself, meaning if the Space is removed so is the Location if it does not belong in the given Library.
+
+Spaces will be AI native, using our custom embedding architecture, we can dynamically embed an associated vector database, pre-generated by Spacedrive tailored specifically to that Space to enable AI features such as chat, deep search and workflows.
+
+In the future, Objects can be organized and presented spatially, with various layouts and variable grid placements. Color themes, icon packs and typography can be customized per Space.
diff --git a/docs/developers/architecture/vdfs.mdx b/docs/developers/architecture/vdfs.mdx
@@ -11,5 +11,9 @@ A virtual filesystem is simply a layer of abstraction between a physical filesys
 ## How it works
 
 Spacedrive defines a VDFS under the following data model; A Library, Nodes, Volumes, Locations, Paths and Objects.
+- A node is a single machine running the VDFS software.
+- It syncronizes a CRDT based database, called the Library, with other nodes in the network.
+- The library consists of Locations, found on Volumes,
+- These contain Paths to files on the underlying filesystem.
 
-A node is a single machine running the VDFS software, it syncronizes a CRDT based database, called the Library, with other nodes in the network. The library consists of Locations, found on Volumes, which contain Paths to files on the underlying filesystem.
+Objects are unique representations of files sorted by a sampled hash called a "cas_id" which stands for "Content Addressable Storage Identifier". Additional metadata like tags and comments are tied to the Objects. Folders are not assigned to objects by default, but if a tag is assigned then an Object is created to accomedate.